Package net.opengis.wps10

Interface DocumentOutputDefinitionType

All Superinterfaces:

EObject, Notifier, OutputDefinitionType

All Known Implementing Classes:

DocumentOutputDefinitionTypeImpl

public interface DocumentOutputDefinitionType
extends OutputDefinitionType

A representation of the model object 'Document Output Definition Type'. Definition of a format, encoding, schema, and unit-of-measure for an output to be returned from a process. In this use, the DescriptionType shall describe this process input or output.

The following features are supported:

• Title
• Abstract
• As Reference

See Also:

• Wps10Package.getDocumentOutputDefinitionType()

Method Summary

Modifier and Type	Method	Description
LanguageStringType	getAbstract()	Returns the value of the 'Abstract' containment reference.
LanguageStringType	getTitle()	Returns the value of the 'Title' containment reference.
boolean	isAsReference()	Returns the value of the 'As Reference' attribute.
boolean	isSetAsReference()	Returns whether the value of the 'As Reference' attribute is set.
void	setAbstract(LanguageStringType value)	Sets the value of the 'Abstract' containment reference.
void	setAsReference(boolean value)	Sets the value of the 'As Reference' attribute.
void	setTitle(LanguageStringType value)	Sets the value of the 'Title' containment reference.
void	unsetAsReference()	Unsets the value of the 'As Reference' 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 OutputDefinitionType

getEncoding, getIdentifier, getMimeType, getSchema, getUom, setEncoding, setIdentifier, setMimeType, setSchema, setUom

Method Details

getTitle

LanguageStringType getTitle()

Returns the value of the 'Title' containment reference. Title of the process output, normally available for display to a human. This element should be used if the client wishes to customize the Title in the execute response. This element should not be used if the Title provided for this output in the ProcessDescription is adequate.

Returns:

the value of the 'Title' containment reference.

See Also:

• setTitle(LanguageStringType)
• Wps10Package.getDocumentOutputDefinitionType_Title()

setTitle

void setTitle(LanguageStringType value)

Sets the value of the 'Title' containment reference.

Parameters:

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

See Also:

• getTitle()

getAbstract

LanguageStringType getAbstract()

Returns the value of the 'Abstract' containment reference. Brief narrative description of a process output, normally available for display to a human. This element should be used if the client wishes to customize the Abstract in the execute response. This element should not be used if the Abstract provided for this output in the ProcessDescription is adequate.

Returns:

the value of the 'Abstract' containment reference.

See Also:

• setAbstract(LanguageStringType)
• Wps10Package.getDocumentOutputDefinitionType_Abstract()

setAbstract

void setAbstract(LanguageStringType value)

Sets the value of the 'Abstract' containment reference.

Parameters:

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

See Also:

• getAbstract()

isAsReference

boolean isAsReference()

Returns the value of the 'As Reference' attribute. The default value is "false". Specifies if this output should be stored by the process as a web-accessible resource. If asReference is "true", the server shall store this output so that the client can retrieve it as required. If store is "false", all the output shall be encoded in the Execute operation response document. This parameter only applies to ComplexData outputs. This parameter shall not be included unless the corresponding "storeSupported" parameter is included and is "true" in the ProcessDescription for this process.

Returns:

the value of the 'As Reference' attribute.

See Also:

• isSetAsReference()
• unsetAsReference()
• setAsReference(boolean)
• Wps10Package.getDocumentOutputDefinitionType_AsReference()

setAsReference

void setAsReference(boolean value)

Sets the value of the 'As Reference' attribute.

Parameters:

value - the new value of the 'As Reference' attribute.

See Also:

• isSetAsReference()
• unsetAsReference()
• isAsReference()

unsetAsReference

void unsetAsReference()

Unsets the value of the 'As Reference' attribute.

See Also:

• isSetAsReference()
• isAsReference()
• setAsReference(boolean)

isSetAsReference

boolean isSetAsReference()

Returns whether the value of the 'As Reference' attribute is set.

Returns:

whether the value of the 'As Reference' attribute is set.

See Also:

• unsetAsReference()
• isAsReference()
• setAsReference(boolean)