Package net.opengis.wps20

Interface StatusInfoType

All Superinterfaces:

EObject, Notifier

All Known Implementing Classes:

StatusInfoTypeImpl

public interface StatusInfoType
extends EObject

A representation of the model object 'Status Info Type'.

The following features are supported:

• Job ID
• Status
• Expiration Date
• Estimated Completion
• Next Poll
• Percent Completed

See Also:

Wps20Package.getStatusInfoType()

Method Summary

Modifier and Type	Method	Description
XMLGregorianCalendar	getEstimatedCompletion()	Returns the value of the 'Estimated Completion' attribute.
XMLGregorianCalendar	getExpirationDate()	Returns the value of the 'Expiration Date' attribute.
String	getJobID()	Returns the value of the 'Job ID' attribute.
XMLGregorianCalendar	getNextPoll()	Returns the value of the 'Next Poll' attribute.
BigInteger	getPercentCompleted()	Returns the value of the 'Percent Completed' attribute.
Object	getStatus()	Returns the value of the 'Status' attribute.
void	setEstimatedCompletion(XMLGregorianCalendar value)	Sets the value of the 'Estimated Completion' attribute.
void	setExpirationDate(XMLGregorianCalendar value)	Sets the value of the 'Expiration Date' attribute.
void	setJobID(String value)	Sets the value of the 'Job ID' attribute.
void	setNextPoll(XMLGregorianCalendar value)	Sets the value of the 'Next Poll' attribute.
void	setPercentCompleted(BigInteger value)	Sets the value of the 'Percent Completed' attribute.
void	setStatus(Object value)	Sets the value of the 'Status' 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

Method Detail

getJobID

String 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.getStatusInfoType_JobID()

setJobID

void setJobID(String value)

Sets the value of the 'Job ID' attribute.

Parameters:

value - the new value of the 'Job ID' attribute.

See Also:

getJobID()

getStatus

Object getStatus()

Returns the value of the 'Status' attribute. This element is used to communicate basic status information about executed processes.

Returns:

the value of the 'Status' attribute.

See Also:

setStatus(Object), Wps20Package.getStatusInfoType_Status()

setStatus

void setStatus(Object value)

Sets the value of the 'Status' attribute.

Parameters:

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

See Also:

getStatus()

getExpirationDate

XMLGregorianCalendar 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.getStatusInfoType_ExpirationDate()

setExpirationDate

void setExpirationDate(XMLGregorianCalendar value)

Sets the value of the 'Expiration Date' attribute.

Parameters:

value - the new value of the 'Expiration Date' attribute.

See Also:

getExpirationDate()

getEstimatedCompletion

XMLGregorianCalendar getEstimatedCompletion()

Returns the value of the 'Estimated Completion' attribute. Estimated date and time by which the job will be completed. Use if available. The time of estimated completion lies significantly before the expiration date of this job.

Returns:

the value of the 'Estimated Completion' attribute.

See Also:

setEstimatedCompletion(XMLGregorianCalendar), Wps20Package.getStatusInfoType_EstimatedCompletion()

setEstimatedCompletion

void setEstimatedCompletion(XMLGregorianCalendar value)

Sets the value of the 'Estimated Completion' attribute.

Parameters:

value - the new value of the 'Estimated Completion' attribute.

See Also:

getEstimatedCompletion()

getNextPoll

XMLGregorianCalendar getNextPoll()

Returns the value of the 'Next Poll' attribute. Suggested date and time for the next status poll (GetStatus) for this job. Use if appropriate. The time of the next poll shall lie significantly before the expiration date of this job. If this element is provided but an expiration date for the job is not given, clients are expected to check the job status on time to eventually receive an update on the expiration date and avoid missing the results.

Returns:

the value of the 'Next Poll' attribute.

See Also:

setNextPoll(XMLGregorianCalendar), Wps20Package.getStatusInfoType_NextPoll()

setNextPoll

void setNextPoll(XMLGregorianCalendar value)

Sets the value of the 'Next Poll' attribute.

Parameters:

value - the new value of the 'Next Poll' attribute.

See Also:

getNextPoll()

getPercentCompleted

BigInteger getPercentCompleted()

Returns the value of the 'Percent Completed' attribute. Use as a progress indicator if appropriate. Like most progress bars the value is an estimate without accuracy guarantees.

Returns:

the value of the 'Percent Completed' attribute.

See Also:

setPercentCompleted(BigInteger), Wps20Package.getStatusInfoType_PercentCompleted()

setPercentCompleted

void setPercentCompleted(BigInteger value)

Sets the value of the 'Percent Completed' attribute.

Parameters:

value - the new value of the 'Percent Completed' attribute.

See Also:

getPercentCompleted()