eu.planets_project.services.view
Interface CreateView

All Superinterfaces:

PlanetsService

@MTOM
@StreamingAttachment(parseEagerly=true,
                     memoryThreshold=10485760L)
public interface CreateView
extends PlanetsService

The purpose of the CreateView operation is to take a Digital Object and to wrap it up so that the user can examine it more easily. The service returns a URL pointing to the web site or downloadable package that will provide the rendering experience to the user. It is envisaged that this URL will be passed back to the user as a new link to open in a new browser window.

Field Summary

static java.lang.String	NAME The interface name.
static javax.xml.namespace.QName	QNAME The qualified name.

Method Summary

CreateViewResult	createView(java.util.List<DigitalObject> digitalObjects, java.util.List<Parameter> parameters)
ViewActionResult	doAction(java.lang.String sessionIdentifier, java.lang.String action) FIXME Should this have an optional list of parameters?
ViewStatus	getViewStatus(java.lang.String sessionIdentifier)

Methods inherited from interface eu.planets_project.services.PlanetsService

describe

Field Detail

NAME

static final java.lang.String NAME

The interface name.

See Also:

Constant Field Values

QNAME

static final javax.xml.namespace.QName QNAME

The qualified name.

Method Detail

createView

CreateViewResult createView(java.util.List<DigitalObject> digitalObjects,
                            java.util.List<Parameter> parameters)

Parameters:

digitalObjects - The Digital Objects to be viewed.

Returns:

Returns a CreateViewResult that contains to a URL where the objects may be viewed.

getViewStatus

ViewStatus getViewStatus(java.lang.String sessionIdentifier)

Parameters:

sessionIdentifier - A key that allows the service to uniquely identify the user's session.

Returns:

A description of the current state of that session, optionally including properties determined from the session.

doAction

ViewActionResult doAction(java.lang.String sessionIdentifier,
                          java.lang.String action)

FIXME Should this have an optional list of parameters?

Parameters:

sessionIdentifier - A key that allows the service to uniquely identify the user's session.

Returns:

A description of the current state of that session, optionally including properties determined from the session.