Package net.opengis.wps20
Interface DocumentRoot
- 
- All Superinterfaces:
- EObject,- Notifier
 - All Known Implementing Classes:
- DocumentRootImpl
 
 public interface DocumentRoot extends EObjectA representation of the model object 'Document Root'.The following features are supported: - Mixed
- XMLNS Prefix Map
- XSI Schema Location
- Bounding Box Data
- Data Description
- Capabilities
- Complex Data
- Contents
- Data
- Describe Process
- Dismiss
- Execute
- Expiration Date
- Format
- Generic Process
- Get Capabilities
- Get Result
- Get Status
- Job ID
- Literal Data
- Literal Value
- Process
- Process Offering
- Process Offerings
- Reference
- Result
- Status Info
- Supported CRS
 - See Also:
- Wps20Package.getDocumentRoot()
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description BoundingBoxDataTypegetBoundingBoxData()Returns the value of the 'Bounding Box Data' containment reference.WPSCapabilitiesTypegetCapabilities()Returns the value of the 'Capabilities' containment reference.ComplexDataTypegetComplexData()Returns the value of the 'Complex Data' containment reference.ContentsTypegetContents()Returns the value of the 'Contents' containment reference.DataTypegetData()Returns the value of the 'Data' containment reference.DataDescriptionTypegetDataDescription()Returns the value of the 'Data Description' containment reference.DescribeProcessTypegetDescribeProcess()Returns the value of the 'Describe Process' containment reference.DismissTypegetDismiss()Returns the value of the 'Dismiss' containment reference.ExecuteRequestTypegetExecute()Returns the value of the 'Execute' containment reference.XMLGregorianCalendargetExpirationDate()Returns the value of the 'Expiration Date' attribute.FormatTypegetFormat()Returns the value of the 'Format' containment reference.GenericProcessTypegetGenericProcess()Returns the value of the 'Generic Process' containment reference.GetCapabilitiesTypegetGetCapabilities()Returns the value of the 'Get Capabilities' containment reference.GetResultTypegetGetResult()Returns the value of the 'Get Result' containment reference.GetStatusTypegetGetStatus()Returns the value of the 'Get Status' containment reference.StringgetJobID()Returns the value of the 'Job ID' attribute.LiteralDataTypegetLiteralData()Returns the value of the 'Literal Data' containment reference.LiteralValueTypegetLiteralValue()Returns the value of the 'Literal Value' containment reference.FeatureMapgetMixed()Returns the value of the 'Mixed' attribute list.ProcessDescriptionTypegetProcess()Returns the value of the 'Process' containment reference.ProcessOfferingTypegetProcessOffering()Returns the value of the 'Process Offering' containment reference.ProcessOfferingsTypegetProcessOfferings()Returns the value of the 'Process Offerings' containment reference.ReferenceTypegetReference()Returns the value of the 'Reference' containment reference.ResultTypegetResult()Returns the value of the 'Result' containment reference.StatusInfoTypegetStatusInfo()Returns the value of the 'Status Info' containment reference.SupportedCRSTypegetSupportedCRS()Returns the value of the 'Supported CRS' containment reference.EMap<String,String>getXMLNSPrefixMap()Returns the value of the 'XMLNS Prefix Map' map.EMap<String,String>getXSISchemaLocation()Returns the value of the 'XSI Schema Location' map.voidsetBoundingBoxData(BoundingBoxDataType value)Sets the value of the 'Bounding Box Data' containment reference.voidsetCapabilities(WPSCapabilitiesType value)Sets the value of the 'Capabilities' containment reference.voidsetComplexData(ComplexDataType value)Sets the value of the 'Complex Data' containment reference.voidsetContents(ContentsType value)Sets the value of the 'Contents' containment reference.voidsetData(DataType value)Sets the value of the 'Data' containment reference.voidsetDescribeProcess(DescribeProcessType value)Sets the value of the 'Describe Process' containment reference.voidsetDismiss(DismissType value)Sets the value of the 'Dismiss' containment reference.voidsetExecute(ExecuteRequestType value)Sets the value of the 'Execute' containment reference.voidsetExpirationDate(XMLGregorianCalendar value)Sets the value of the 'Expiration Date' attribute.voidsetFormat(FormatType value)Sets the value of the 'Format' containment reference.voidsetGenericProcess(GenericProcessType value)Sets the value of the 'Generic Process' containment reference.voidsetGetCapabilities(GetCapabilitiesType value)Sets the value of the 'Get Capabilities' containment reference.voidsetGetResult(GetResultType value)Sets the value of the 'Get Result' containment reference.voidsetGetStatus(GetStatusType value)Sets the value of the 'Get Status' containment reference.voidsetJobID(String value)Sets the value of the 'Job ID' attribute.voidsetLiteralData(LiteralDataType value)Sets the value of the 'Literal Data' containment reference.voidsetLiteralValue(LiteralValueType value)Sets the value of the 'Literal Value' containment reference.voidsetProcess(ProcessDescriptionType value)Sets the value of the 'Process' containment reference.voidsetProcessOffering(ProcessOfferingType value)Sets the value of the 'Process Offering' containment reference.voidsetProcessOfferings(ProcessOfferingsType value)Sets the value of the 'Process Offerings' containment reference.voidsetReference(ReferenceType value)Sets the value of the 'Reference' containment reference.voidsetResult(ResultType value)Sets the value of the 'Result' containment reference.voidsetStatusInfo(StatusInfoType value)Sets the value of the 'Status Info' containment reference.voidsetSupportedCRS(SupportedCRSType value)Sets the value of the 'Supported CRS' containment reference.
 
- 
- 
- 
Method Detail- 
getMixedFeatureMap getMixed() Returns the value of the 'Mixed' attribute list. The list contents are of typeFeatureMap.Entry.- Returns:
- the value of the 'Mixed' attribute list.
- See Also:
- Wps20Package.getDocumentRoot_Mixed()
 
 - 
getXMLNSPrefixMapEMap<String,String> getXMLNSPrefixMap() Returns the value of the 'XMLNS Prefix Map' map. The key is of typeString, and the value is of typeString,- Returns:
- the value of the 'XMLNS Prefix Map' map.
- See Also:
- Wps20Package.getDocumentRoot_XMLNSPrefixMap()
 
 - 
getXSISchemaLocationEMap<String,String> getXSISchemaLocation() Returns the value of the 'XSI Schema Location' map. The key is of typeString, and the value is of typeString,- Returns:
- the value of the 'XSI Schema Location' map.
- See Also:
- Wps20Package.getDocumentRoot_XSISchemaLocation()
 
 - 
getBoundingBoxDataBoundingBoxDataType getBoundingBoxData() Returns the value of the 'Bounding Box Data' containment reference. Indicates that this Input shall be a BoundingBox data structure that is embedded in the execute request, and provides a list of the Coordinate Reference System support for this Bounding Box.- Returns:
- the value of the 'Bounding Box Data' containment reference.
- See Also:
- setBoundingBoxData(BoundingBoxDataType),- Wps20Package.getDocumentRoot_BoundingBoxData()
 
 - 
setBoundingBoxDatavoid setBoundingBoxData(BoundingBoxDataType value) Sets the value of the 'Bounding Box Data' containment reference.- Parameters:
- value- the new value of the 'Bounding Box Data' containment reference.
- See Also:
- getBoundingBoxData()
 
 - 
getDataDescriptionDataDescriptionType getDataDescription() Returns the value of the 'Data Description' containment reference.- Returns:
- the value of the 'Data Description' containment reference.
- See Also:
- Wps20Package.getDocumentRoot_DataDescription()
 
 - 
getCapabilitiesWPSCapabilitiesType getCapabilities() Returns the value of the 'Capabilities' containment reference. WPS GetCapabilities operation response. This document provides clients with service metadata about a specific service instance, including metadata about the processes that can be executed. Since the server does not implement the updateSequence and Sections parameters, the server shall always return the complete Capabilities document, without the updateSequence parameter.- Returns:
- the value of the 'Capabilities' containment reference.
- See Also:
- setCapabilities(WPSCapabilitiesType),- Wps20Package.getDocumentRoot_Capabilities()
 
 - 
setCapabilitiesvoid setCapabilities(WPSCapabilitiesType value) Sets the value of the 'Capabilities' containment reference.- Parameters:
- value- the new value of the 'Capabilities' containment reference.
- See Also:
- getCapabilities()
 
 - 
getComplexDataComplexDataType getComplexData() Returns the value of the 'Complex Data' containment reference. Indicates that this input/output shall be a complex data structure (such as a GML document or a GeoTiff image that comply with a particular format definition).- Returns:
- the value of the 'Complex Data' containment reference.
- See Also:
- setComplexData(ComplexDataType),- Wps20Package.getDocumentRoot_ComplexData()
 
 - 
setComplexDatavoid setComplexData(ComplexDataType value) Sets the value of the 'Complex Data' containment reference.- Parameters:
- value- the new value of the 'Complex Data' containment reference.
- See Also:
- getComplexData()
 
 - 
getContentsContentsType getContents() Returns the value of the 'Contents' containment reference. List of brief descriptions of the processes offered by this WPS server.- Returns:
- the value of the 'Contents' containment reference.
- See Also:
- setContents(ContentsType),- Wps20Package.getDocumentRoot_Contents()
 
 - 
setContentsvoid setContents(ContentsType value) Sets the value of the 'Contents' containment reference.- Parameters:
- value- the new value of the 'Contents' containment reference.
- See Also:
- getContents()
 
 - 
getDataDataType getData() Returns the value of the 'Data' containment reference.- Returns:
- the value of the 'Data' containment reference.
- See Also:
- setData(DataType),- Wps20Package.getDocumentRoot_Data()
 
 - 
setDatavoid setData(DataType value) Sets the value of the 'Data' containment reference.- Parameters:
- value- the new value of the 'Data' containment reference.
- See Also:
- getData()
 
 - 
getDescribeProcessDescribeProcessType getDescribeProcess() Returns the value of the 'Describe Process' containment reference. WPS DescribeProcess operation request.- Returns:
- the value of the 'Describe Process' containment reference.
- See Also:
- setDescribeProcess(DescribeProcessType),- Wps20Package.getDocumentRoot_DescribeProcess()
 
 - 
setDescribeProcessvoid setDescribeProcess(DescribeProcessType value) Sets the value of the 'Describe Process' containment reference.- Parameters:
- value- the new value of the 'Describe Process' containment reference.
- See Also:
- getDescribeProcess()
 
 - 
getDismissDismissType getDismiss() Returns the value of the 'Dismiss' containment reference. WPS GetStatus operation request. This operation is used to query status information of executed processes. The response to a GetStatus operation is a StatusInfo document or an exception. Depending on the implementation, a WPS may "forget" old process executions sooner or later. In this case, there is no status information available and an exception shall be returned instead of a StatusInfo response.- Returns:
- the value of the 'Dismiss' containment reference.
- See Also:
- setDismiss(DismissType),- Wps20Package.getDocumentRoot_Dismiss()
 
 - 
setDismissvoid setDismiss(DismissType value) Sets the value of the 'Dismiss' containment reference.- Parameters:
- value- the new value of the 'Dismiss' containment reference.
- See Also:
- getDismiss()
 
 - 
getExecuteExecuteRequestType getExecute() Returns the value of the 'Execute' containment reference.- Returns:
- the value of the 'Execute' containment reference.
- See Also:
- setExecute(ExecuteRequestType),- Wps20Package.getDocumentRoot_Execute()
 
 - 
setExecutevoid setExecute(ExecuteRequestType value) Sets the value of the 'Execute' containment reference.- Parameters:
- value- the new value of the 'Execute' containment reference.
- See Also:
- getExecute()
 
 - 
getExpirationDateXMLGregorianCalendar getExpirationDate() Returns the value of the 'Expiration Date' attribute. Date and time by which the job and its results will be removed from the server. Use if appropriate. In some situations the expiration date may not be known from the start. In this case, it is recommended to specify a timestamp for NextPoll. A typical example is a long running process for which the results are stored 48 hours after completion. While the process is running, clients are provided with updated timestamps for NextPoll. As soon as the process has completed the ExpirationDate is determined.- Returns:
- the value of the 'Expiration Date' attribute.
- See Also:
- setExpirationDate(XMLGregorianCalendar),- Wps20Package.getDocumentRoot_ExpirationDate()
 
 - 
setExpirationDatevoid setExpirationDate(XMLGregorianCalendar value) Sets the value of the 'Expiration Date' attribute.- Parameters:
- value- the new value of the 'Expiration Date' attribute.
- See Also:
- getExpirationDate()
 
 - 
getFormatFormatType getFormat() Returns the value of the 'Format' containment reference.- Returns:
- the value of the 'Format' containment reference.
- See Also:
- setFormat(FormatType),- Wps20Package.getDocumentRoot_Format()
 
 - 
setFormatvoid setFormat(FormatType value) Sets the value of the 'Format' containment reference.- Parameters:
- value- the new value of the 'Format' containment reference.
- See Also:
- getFormat()
 
 - 
getGenericProcessGenericProcessType getGenericProcess() Returns the value of the 'Generic Process' containment reference.- Returns:
- the value of the 'Generic Process' containment reference.
- See Also:
- setGenericProcess(GenericProcessType),- Wps20Package.getDocumentRoot_GenericProcess()
 
 - 
setGenericProcessvoid setGenericProcess(GenericProcessType value) Sets the value of the 'Generic Process' containment reference.- Parameters:
- value- the new value of the 'Generic Process' containment reference.
- See Also:
- getGenericProcess()
 
 - 
getGetCapabilitiesGetCapabilitiesType getGetCapabilities() Returns the value of the 'Get Capabilities' containment reference. Request to a WPS server to perform the GetCapabilities operation. This operation allows a client to retrieve a Capabilities XML document providing metadata for the specific WPS server.- Returns:
- the value of the 'Get Capabilities' containment reference.
- See Also:
- setGetCapabilities(GetCapabilitiesType),- Wps20Package.getDocumentRoot_GetCapabilities()
 
 - 
setGetCapabilitiesvoid setGetCapabilities(GetCapabilitiesType value) Sets the value of the 'Get Capabilities' containment reference.- Parameters:
- value- the new value of the 'Get Capabilities' containment reference.
- See Also:
- getGetCapabilities()
 
 - 
getGetResultGetResultType getGetResult() Returns the value of the 'Get Result' containment reference. WPS GetResult operation request. This operation is used to query the results of asynchrously executed processes. The response to a GetResult operation is a wps:ProcessingResult, a raw data response, or an exception. Depending on the implementation, a WPS may "forget" old process executions sooner or later. In this case, there is no result information available and an exception shall be returned.- Returns:
- the value of the 'Get Result' containment reference.
- See Also:
- setGetResult(GetResultType),- Wps20Package.getDocumentRoot_GetResult()
 
 - 
setGetResultvoid setGetResult(GetResultType value) Sets the value of the 'Get Result' containment reference.- Parameters:
- value- the new value of the 'Get Result' containment reference.
- See Also:
- getGetResult()
 
 - 
getGetStatusGetStatusType getGetStatus() Returns the value of the 'Get Status' containment reference. WPS GetStatus operation request. This operation is used to query status information of executed processes. The response to a GetStatus operation is a StatusInfo document or an exception. Depending on the implementation, a WPS may "forget" old process executions sooner or later. In this case, there is no status information available and an exception shall be returned instead of a StatusInfo response.- Returns:
- the value of the 'Get Status' containment reference.
- See Also:
- setGetStatus(GetStatusType),- Wps20Package.getDocumentRoot_GetStatus()
 
 - 
setGetStatusvoid setGetStatus(GetStatusType value) Sets the value of the 'Get Status' containment reference.- Parameters:
- value- the new value of the 'Get Status' containment reference.
- See Also:
- getGetStatus()
 
 - 
getJobIDString getJobID() Returns the value of the 'Job ID' attribute. A JobID is a unique identifier for a process execution, i.e. a process instance. Particularly suitable JobIDs are UUIDs or monotonic identifiers such as unique timestamps. If the privacy of a Processing Job is imperative, the JobID should be non-guessable.- Returns:
- the value of the 'Job ID' attribute.
- See Also:
- setJobID(String),- Wps20Package.getDocumentRoot_JobID()
 
 - 
setJobIDvoid setJobID(String value) Sets the value of the 'Job ID' attribute.- Parameters:
- value- the new value of the 'Job ID' attribute.
- See Also:
- getJobID()
 
 - 
getLiteralDataLiteralDataType getLiteralData() Returns the value of the 'Literal Data' containment reference.- Returns:
- the value of the 'Literal Data' containment reference.
- See Also:
- setLiteralData(LiteralDataType),- Wps20Package.getDocumentRoot_LiteralData()
 
 - 
setLiteralDatavoid setLiteralData(LiteralDataType value) Sets the value of the 'Literal Data' containment reference.- Parameters:
- value- the new value of the 'Literal Data' containment reference.
- See Also:
- getLiteralData()
 
 - 
getLiteralValueLiteralValueType getLiteralValue() Returns the value of the 'Literal Value' containment reference.- Returns:
- the value of the 'Literal Value' containment reference.
- See Also:
- setLiteralValue(LiteralValueType),- Wps20Package.getDocumentRoot_LiteralValue()
 
 - 
setLiteralValuevoid setLiteralValue(LiteralValueType value) Sets the value of the 'Literal Value' containment reference.- Parameters:
- value- the new value of the 'Literal Value' containment reference.
- See Also:
- getLiteralValue()
 
 - 
getProcessProcessDescriptionType getProcess() Returns the value of the 'Process' containment reference. The description of a single process, including the input and output items.- Returns:
- the value of the 'Process' containment reference.
- See Also:
- setProcess(ProcessDescriptionType),- Wps20Package.getDocumentRoot_Process()
 
 - 
setProcessvoid setProcess(ProcessDescriptionType value) Sets the value of the 'Process' containment reference.- Parameters:
- value- the new value of the 'Process' containment reference.
- See Also:
- getProcess()
 
 - 
getProcessOfferingProcessOfferingType getProcessOffering() Returns the value of the 'Process Offering' containment reference. A process offering is a process description. It has additional attributes that provide additional information on how this process can be executed on a particular service instance (execution modes, data transmission modes, informative process version.)- Returns:
- the value of the 'Process Offering' containment reference.
- See Also:
- setProcessOffering(ProcessOfferingType),- Wps20Package.getDocumentRoot_ProcessOffering()
 
 - 
setProcessOfferingvoid setProcessOffering(ProcessOfferingType value) Sets the value of the 'Process Offering' containment reference.- Parameters:
- value- the new value of the 'Process Offering' containment reference.
- See Also:
- getProcessOffering()
 
 - 
getProcessOfferingsProcessOfferingsType getProcessOfferings() Returns the value of the 'Process Offerings' containment reference. List structure that is returned by the WPS DescribeProcess operation. Contains XML descriptions for the queried process identifiers.- Returns:
- the value of the 'Process Offerings' containment reference.
- See Also:
- setProcessOfferings(ProcessOfferingsType),- Wps20Package.getDocumentRoot_ProcessOfferings()
 
 - 
setProcessOfferingsvoid setProcessOfferings(ProcessOfferingsType value) Sets the value of the 'Process Offerings' containment reference.- Parameters:
- value- the new value of the 'Process Offerings' containment reference.
- See Also:
- getProcessOfferings()
 
 - 
getReferenceReferenceType getReference() Returns the value of the 'Reference' containment reference. This element is used for web accessible references to a data set or value.- Returns:
- the value of the 'Reference' containment reference.
- See Also:
- setReference(ReferenceType),- Wps20Package.getDocumentRoot_Reference()
 
 - 
setReferencevoid setReference(ReferenceType value) Sets the value of the 'Reference' containment reference.- Parameters:
- value- the new value of the 'Reference' containment reference.
- See Also:
- getReference()
 
 - 
getResultResultType getResult() Returns the value of the 'Result' containment reference. A Result document is a structure that contains the results of a process execution. It is a shared element between the Execute and GetResult operations.- Returns:
- the value of the 'Result' containment reference.
- See Also:
- setResult(ResultType),- Wps20Package.getDocumentRoot_Result()
 
 - 
setResultvoid setResult(ResultType value) Sets the value of the 'Result' containment reference.- Parameters:
- value- the new value of the 'Result' containment reference.
- See Also:
- getResult()
 
 - 
getStatusInfoStatusInfoType getStatusInfo() Returns the value of the 'Status Info' containment reference. StatusInfo document containing information about executed processes.- Returns:
- the value of the 'Status Info' containment reference.
- See Also:
- setStatusInfo(StatusInfoType),- Wps20Package.getDocumentRoot_StatusInfo()
 
 - 
setStatusInfovoid setStatusInfo(StatusInfoType value) Sets the value of the 'Status Info' containment reference.- Parameters:
- value- the new value of the 'Status Info' containment reference.
- See Also:
- getStatusInfo()
 
 - 
getSupportedCRSSupportedCRSType getSupportedCRS() Returns the value of the 'Supported CRS' containment reference. Supported CRS supported for this Input/Output. "default" shall be used on only one element. This default element identifies the default CRS.- Returns:
- the value of the 'Supported CRS' containment reference.
- See Also:
- setSupportedCRS(SupportedCRSType),- Wps20Package.getDocumentRoot_SupportedCRS()
 
 - 
setSupportedCRSvoid setSupportedCRS(SupportedCRSType value) Sets the value of the 'Supported CRS' containment reference.- Parameters:
- value- the new value of the 'Supported CRS' containment reference.
- See Also:
- getSupportedCRS()
 
 
- 
 
-