org.deegree.protocol.wps.client.process.execute
Class ResponseFormat

java.lang.Object
  org.deegree.protocol.wps.client.process.execute.ResponseFormat

public class ResponseFormat
extends Object

Encapsulates the requested settings for a process execution response.

Version:

$Revision: 26137 $, $Date: 2010-08-25 18:05:25 +0200 (Wed, 25 Aug 2010) $

Author:

Andrei Ionita, Markus Schneider, last edited by: $Author: aionita $

Constructor Summary

ResponseFormat(boolean rawOutput, boolean storeResponse, boolean includeInputs, boolean updateStatus, List<OutputFormat> outputDefs)
Creates a new ResponseFormat instance.

Method Summary

List<OutputFormat>	getOutputDefinitions() Returns the requested outputs.
boolean	includeInputs() Returns whether the input parameters should be repeated in the response (lineage).
boolean	returnRawOutput() Returns whether the output should be "raw" (just one output parameter) instead of a response document.
boolean	storeResponse() Returns whether the server should store the output response (and provide a web-accessible URL in the response document).
boolean	updateStatus() Returns whether the server should provide updated response documents (asynchronous execution).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseFormat

public ResponseFormat(boolean rawOutput,
                      boolean storeResponse,
                      boolean includeInputs,
                      boolean updateStatus,
                      List<OutputFormat> outputDefs)

Creates a new ResponseFormat instance.

Parameters:

rawOutput - true, if a raw response is requested, false means response document

storeResponse - true, if the server should store the output response (and provide a web-accessible URL for it), false otherwise

includeInputs - true, if the input parameters should be repeated in the response (lineage), false otherwise

updateStatus - true, if the server should provide updated response documents (asynchronous execution), false otherwise

outputDefs - the requested outputs, can be empty (indicates to return all outputs), but must not be null

Method Detail

returnRawOutput

public boolean returnRawOutput()

Returns whether the output should be "raw" (just one output parameter) instead of a response document.

Returns:

true, if a raw response is requested, false means response document

storeResponse

public boolean storeResponse()

Returns whether the server should store the output response (and provide a web-accessible URL in the response document).

Returns:

true, if the server should store the output response, false otherwise

includeInputs

public boolean includeInputs()

Returns whether the input parameters should be repeated in the response (lineage).

Returns:

true, if the input parameters should be repeated, false otherwise

updateStatus

public boolean updateStatus()

Returns whether the server should provide updated response documents (asynchronous execution).

Returns:

true, if the server should provide updated response documents, false otherwise

getOutputDefinitions

public List<OutputFormat> getOutputDefinitions()

Returns the requested outputs.

Returns:

the requested outputs, can be empty (indicates to return all outputs), but never null