Package net.opengis.wps10

Interface ExecuteResponseType

All Superinterfaces:

EObject, Notifier, ResponseBaseType

All Known Implementing Classes:

ExecuteResponseTypeImpl

public interface ExecuteResponseType
extends ResponseBaseType

A representation of the model object 'Execute Response Type'.

The following features are supported:

• Process
• Status
• Data Inputs
• Output Definitions
• Process Outputs
• Service Instance
• Status Location

See Also:

Wps10Package.getExecuteResponseType()

Method Summary

Modifier and Type	Method	Description
DataInputsType1	getDataInputs()	Returns the value of the 'Data Inputs' containment reference.
OutputDefinitionsType	getOutputDefinitions()	Returns the value of the 'Output Definitions' containment reference.
ProcessBriefType	getProcess()	Returns the value of the 'Process' containment reference.
ProcessOutputsType1	getProcessOutputs()	Returns the value of the 'Process Outputs' containment reference.
String	getServiceInstance()	Returns the value of the 'Service Instance' attribute.
StatusType	getStatus()	Returns the value of the 'Status' containment reference.
String	getStatusLocation()	Returns the value of the 'Status Location' attribute.
void	setDataInputs(DataInputsType1 value)	Sets the value of the 'Data Inputs' containment reference.
void	setOutputDefinitions(OutputDefinitionsType value)	Sets the value of the 'Output Definitions' containment reference.
void	setProcess(ProcessBriefType value)	Sets the value of the 'Process' containment reference.
void	setProcessOutputs(ProcessOutputsType1 value)	Sets the value of the 'Process Outputs' containment reference.
void	setServiceInstance(String value)	Sets the value of the 'Service Instance' attribute.
void	setStatus(StatusType value)	Sets the value of the 'Status' containment reference.
void	setStatusLocation(String value)	Sets the value of the 'Status Location' attribute.

Methods inherited from interface EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface ResponseBaseType

getLang, getService, getVersion, isSetService, isSetVersion, setLang, setService, setVersion, unsetService, unsetVersion

Method Detail

getProcess

ProcessBriefType getProcess()

Returns the value of the 'Process' containment reference. Process description from the ProcessOfferings section of the GetCapabilities response.

Returns:

the value of the 'Process' containment reference.

See Also:

setProcess(ProcessBriefType), Wps10Package.getExecuteResponseType_Process()

setProcess

void setProcess(ProcessBriefType value)

Sets the value of the 'Process' containment reference.

Parameters:

value - the new value of the 'Process' containment reference.

See Also:

getProcess()

getStatus

StatusType getStatus()

Returns the value of the 'Status' containment reference. Execution status of this process.

Returns:

the value of the 'Status' containment reference.

See Also:

setStatus(StatusType), Wps10Package.getExecuteResponseType_Status()

setStatus

void setStatus(StatusType value)

Sets the value of the 'Status' containment reference.

Parameters:

value - the new value of the 'Status' containment reference.

See Also:

getStatus()

getDataInputs

DataInputsType1 getDataInputs()

Returns the value of the 'Data Inputs' containment reference. Inputs that were provided as part of the execute request. This element shall be omitted unless the lineage attribute of the execute request is set to "true".

Returns:

the value of the 'Data Inputs' containment reference.

See Also:

setDataInputs(DataInputsType1), Wps10Package.getExecuteResponseType_DataInputs()

setDataInputs

void setDataInputs(DataInputsType1 value)

Sets the value of the 'Data Inputs' containment reference.

Parameters:

value - the new value of the 'Data Inputs' containment reference.

See Also:

getDataInputs()

getOutputDefinitions

OutputDefinitionsType getOutputDefinitions()

Returns the value of the 'Output Definitions' containment reference. Complete list of Output data types that were requested as part of the Execute request. This element shall be omitted unless the lineage attribute of the execute request is set to "true".

Returns:

the value of the 'Output Definitions' containment reference.

See Also:

setOutputDefinitions(OutputDefinitionsType), Wps10Package.getExecuteResponseType_OutputDefinitions()

setOutputDefinitions

void setOutputDefinitions(OutputDefinitionsType value)

Sets the value of the 'Output Definitions' containment reference.

Parameters:

value - the new value of the 'Output Definitions' containment reference.

See Also:

getOutputDefinitions()

getProcessOutputs

ProcessOutputsType1 getProcessOutputs()

Returns the value of the 'Process Outputs' containment reference. List of values of the Process output parameters. Normally there would be at least one output when the process has completed successfully. If the process has not finished executing, the implementer can choose to include whatever final results are ready at the time the Execute response is provided. If the reference locations of outputs are known in advance, these URLs may be provided before they are populated.

Returns:

the value of the 'Process Outputs' containment reference.

See Also:

setProcessOutputs(ProcessOutputsType1), Wps10Package.getExecuteResponseType_ProcessOutputs()

setProcessOutputs

void setProcessOutputs(ProcessOutputsType1 value)

Sets the value of the 'Process Outputs' containment reference.

Parameters:

value - the new value of the 'Process Outputs' containment reference.

See Also:

getProcessOutputs()

getServiceInstance

String getServiceInstance()

Returns the value of the 'Service Instance' attribute. This attribute shall contain the GetCapabilities URL of the WPS service which was invoked

Returns:

the value of the 'Service Instance' attribute.

See Also:

setServiceInstance(String), Wps10Package.getExecuteResponseType_ServiceInstance()

setServiceInstance

void setServiceInstance(String value)

Sets the value of the 'Service Instance' attribute.

Parameters:

value - the new value of the 'Service Instance' attribute.

See Also:

getServiceInstance()

getStatusLocation

String getStatusLocation()

Returns the value of the 'Status Location' attribute. The URL referencing the location from which the ExecuteResponse can be retrieved. If "status" is "true" in the Execute request, the ExecuteResponse should also be found here as soon as the process returns the initial response to the client. It should persist at this location as long as the outputs are accessible from the server. The outputs may be stored for as long as the implementer of the server decides. If the process takes a long time, this URL can be repopulated on an ongoing basis in order to keep the client updated on progress. Before the process has succeeded, the ExecuteResponse contains information about the status of the process, including whether or not processing has started, and the percentage completed. It may also optionally contain the inputs and any ProcessStartedType interim results. When the process has succeeded, the ExecuteResponse found at this URL shall contain the output values or references to them.

Returns:

the value of the 'Status Location' attribute.

See Also:

setStatusLocation(String), Wps10Package.getExecuteResponseType_StatusLocation()

setStatusLocation

void setStatusLocation(String value)

Sets the value of the 'Status Location' attribute.

Parameters:

value - the new value of the 'Status Location' attribute.

See Also:

getStatusLocation()