Package net.opengis.wps10

Interface ResponseDocumentType

All Superinterfaces:
EObject, Notifier
All Known Implementing Classes:
ResponseDocumentTypeImpl
public interface ResponseDocumentType extends EObject
A representation of the model object 'Response Document Type'.

The following features are supported:

See Also:

  • Method Details

    • getOutput

      EList getOutput()
      Returns the value of the 'Output' containment reference list. The list contents are of type DocumentOutputDefinitionType. Unordered list of definitions of the outputs (or parameters) requested from the process. These outputs are not normally identified, unless the client is specifically requesting a limited subset of outputs, and/or is requesting output formats and/or schemas and/or encodings different from the defaults and selected from the alternatives identified in the process description, or wishes to customize the descriptive information about the output.
      Returns:
      the value of the 'Output' containment reference list.
      See Also:

    • isLineage

      boolean isLineage()
      Returns the value of the 'Lineage' attribute. The default value is "false". Indicates if the Execute operation response shall include the DataInputs and OutputDefinitions elements. If lineage is "true" the server shall include in the execute response a complete copy of the DataInputs and OutputDefinition elements as received in the execute request. If lineage is "false" then these elements shall be omitted from the response.
      Returns:
      the value of the 'Lineage' attribute.
      See Also:

    • setLineage

      void setLineage(boolean value)
      Sets the value of the 'Lineage' attribute.
      Parameters:
      value - the new value of the 'Lineage' attribute.
      See Also:

    • unsetLineage

      void unsetLineage()
      Unsets the value of the 'Lineage' attribute.
      See Also:

    • isSetLineage

      boolean isSetLineage()
      Returns whether the value of the 'Lineage' attribute is set.
      Returns:
      whether the value of the 'Lineage' attribute is set.
      See Also:

    • isStatus

      boolean isStatus()
      Returns the value of the 'Status' attribute. The default value is "false". Indicates if the stored execute response document shall be updated to provide ongoing reports on the status of execution. If status is "true" and storeExecuteResponse is "true" (and the server has indicated that both storeSupported and statusSupported are "true") then the Status element of the execute response document stored at executeResponseLocation is kept up to date by the process. While the execute response contains ProcessAccepted, ProcessStarted, or ProcessPaused, updates shall be made to the executeResponse document until either the process completes successfully (in which case ProcessSucceeded is populated), or the process fails (in which case ProcessFailed is populated). If status is "false" then the Status element shall not be updated until the process either completes successfully or fails. If status="true" and storeExecuteResponse is "false" then the service shall raise an exception.
      Returns:
      the value of the 'Status' attribute.
      See Also:

    • setStatus

      void setStatus(boolean value)
      Sets the value of the 'Status' attribute.
      Parameters:
      value - the new value of the 'Status' attribute.
      See Also:

    • unsetStatus

      void unsetStatus()
      Unsets the value of the 'Status' attribute.
      See Also:

    • isSetStatus

      boolean isSetStatus()
      Returns whether the value of the 'Status' attribute is set.
      Returns:
      whether the value of the 'Status' attribute is set.
      See Also:

    • isStoreExecuteResponse

      boolean isStoreExecuteResponse()
      Returns the value of the 'Store Execute Response' attribute. The default value is "false". Indicates if the execute response document shall be stored. If "true" then the executeResponseLocation attribute in the execute response becomes mandatory, which will point to the location where the executeResponseDocument is stored. The service shall respond immediately to the request and return an executeResponseDocument containing the executeResponseLocation and the status element which has five possible subelements (choice):ProcessAccepted, ProcessStarted, ProcessPaused, ProcessFailed and ProcessSucceeded, which are chosen and populated as follows: 1) If the process is completed when the initial executeResponseDocument is returned, the element ProcessSucceeded is populated with the process results. 2) If the process already failed when the initial executeResponseDocument is returned, the element ProcessFailed is populated with the Exception. 3) If the process has been paused when the initial executeResponseDocument is returned, the element ProcessPaused is populated. 4) If the process has been accepted when the initial executeResponseDocument is returned, the element ProcessAccepted is populated, including percentage information. 5) If the process execution is ongoing when the initial executeResponseDocument is returned, the element ProcessStarted is populated. In case 3, 4, and 5, if status updating is requested, updates are made to the executeResponseDocument at the executeResponseLocation until either the process completes successfully or fails. Regardless, once the process completes successfully, the ProcessSucceeded element is populated, and if it fails, the ProcessFailed element is populated. Specifies if the Execute operation response shall be returned quickly with status information, or not returned until process execution is complete. This parameter shall not be included unless the corresponding "statusSupported" parameter is included and is "true" in the ProcessDescription for this process.
      Returns:
      the value of the 'Store Execute Response' attribute.
      See Also:

    • setStoreExecuteResponse

      void setStoreExecuteResponse(boolean value)
      Sets the value of the 'Store Execute Response' attribute.
      Parameters:
      value - the new value of the 'Store Execute Response' attribute.
      See Also:

    • unsetStoreExecuteResponse

      void unsetStoreExecuteResponse()
      Unsets the value of the 'Store Execute Response' attribute.
      See Also:

    • isSetStoreExecuteResponse

      boolean isSetStoreExecuteResponse()
      Returns whether the value of the 'Store Execute Response' attribute is set.
      Returns:
      whether the value of the 'Store Execute Response' attribute is set.
      See Also: