Package uk.ac.starlink.vo
Interface UwsJobInfo
public interface UwsJobInfo
Describes the information about a UWS Job which can be retrieved
from a UWS server by retrieving the job's <uws:job> element.
- Since:
- 4 May 2011
- Author:
- Mark Taylor
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Represents error information associated with a UWS job.static interface
Represents a parameter associated with a UWS job.static interface
Represents a result associated with a UWS job. -
Method Summary
Modifier and TypeMethodDescriptionReturns this job's destruction time.Returns this job's end time, if it's ended.getError()
Returns any error information associated with this job.Returns the maximum wall-clock time that this job is permitted to run for, in seconds.getJobId()
Returns this job's ID, unique for this UWS service.Returns this job's owner ID, blank unless authentication is in use.Returns the list of parameter objects associated with this job.getPhase()
Returns this job's current phase.getQuote()
Returns this job's quoted completion time, if any.Returns the list of result objects associted with this job.getRunId()
Returns this job's run ID, often left blank.Returns this job's start time, if it's started.Returns the version of UWS with which this job identifies itself.
-
Method Details
-
getUwsVersion
String getUwsVersion()Returns the version of UWS with which this job identifies itself. A null return means that theversion
attribute is absent from the <job> start tag; that ought to indicate that version 1.0 is in use.- Returns:
- value of
version
attribute in<job>
element
-
getJobId
String getJobId()Returns this job's ID, unique for this UWS service.- Returns:
- job ID
-
getRunId
String getRunId()Returns this job's run ID, often left blank.- Returns:
- run ID
-
getOwnerId
String getOwnerId()Returns this job's owner ID, blank unless authentication is in use.- Returns:
- owner authorization information
-
getPhase
String getPhase()Returns this job's current phase.- Returns:
- phase
- See Also:
-
getQuote
String getQuote()Returns this job's quoted completion time, if any.- Returns:
- quote as an ISO-8601 time
-
getStartTime
String getStartTime()Returns this job's start time, if it's started.- Returns:
- start time in ISO-8601 format
-
getEndTime
String getEndTime()Returns this job's end time, if it's ended.- Returns:
- end time in ISO-8601 format
-
getExecutionDuration
String getExecutionDuration()Returns the maximum wall-clock time that this job is permitted to run for, in seconds. Zero indicates unlimited.- Returns:
- max duration in seconds
-
getDestruction
String getDestruction()Returns this job's destruction time.- Returns:
- time after which the job will be removed in ISO-8601 format
-
getParameters
UwsJobInfo.Parameter[] getParameters()Returns the list of parameter objects associated with this job.- Returns:
- parameter list
-
getResults
UwsJobInfo.Result[] getResults()Returns the list of result objects associted with this job.- Returns:
- result list
-
getError
UwsJobInfo.Error getError()Returns any error information associated with this job.- Returns:
- error object
-