complexType "uws:JobSummary"

Namespace:	http://www.ivoa.net/xml/UWS/v1.0
Content:	complex, 1 attribute, 14 elements
Defined:	globally in UWS.xsd; see XML source
Includes:	definitions of 1 attribute, 14 elements
Used:	at 1 location

Content Model Elements (14):

All Direct / Indirect Based Elements (1):

Known Usage Locations

As direct type of elements (1):
uws:job

The complete representation of the state of a job

XML Source (see within schema source)

<xs:complexType name="JobSummary">

<xs:annotation>

<xs:documentation>

The complete representation of the state of a job

</xs:documentation>

</xs:annotation>

<xs:sequence>

<xs:element name="jobId" type="uws:JobIdentifier"/>

<xs:element maxOccurs="1" minOccurs="0" name="runId" type="xs:string">

<xs:annotation>

<xs:documentation>

this is a client supplied identifier - the UWS system
does nothing other than to return it as part of the
description of the job

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="ownerId" nillable="true" type="xs:string">

<xs:annotation>

<xs:documentation>

the owner (creator) of the job - this should be
expressed as a string that can be parsed in accordance
with IVOA security standards. If there was no
authenticated job creator then this should be set to
NULL.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="phase" type="uws:ExecutionPhase">

<xs:annotation>

<xs:documentation>

the execution phase - returned at
/{jobs}/{job-id}/phase

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="quote" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

A Quote predicts when the job is likely to complete -
returned at /{jobs}/{job-id}/quote "don't know" is
encoded by setting to the XML null value
xsi:nil="true"

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="creationTime" nillable="false" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The instant at which the job was created.

</xs:documentation>

<xs:documentation>

Note that the version 1.1 of the specification requires that this element be present.
It is optional only in versions 1.x of the schema for backwards compatibility.
2.0+ versions of the schema will make this formally mandatory in an XML sense.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="startTime" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The instant at which the job started execution.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="endTime" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The instant at which the job finished execution

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="executionDuration" nillable="false" type="xs:int">

<xs:annotation>

<xs:documentation>

The duration (in seconds) for which the job should be
allowed to run - a value of 0 is intended to mean
unlimited - returned at
/{jobs}/{job-id}/executionduration

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="destruction" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The time at which the whole job + records + results
will be destroyed. returned at
/{jobs}/{job-id}/destruction

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="uws:parameters">

<xs:annotation>

<xs:documentation>

The parameters to the job (where appropriate) can also
be retrieved at /{jobs}/{job-id}/parameters

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element ref="uws:results">

<xs:annotation>

<xs:documentation>

The results for the job - can also be retrieved at
/{jobs}/{job-id}/results

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="errorSummary" type="uws:ErrorSummary"/>

<xs:element maxOccurs="1" minOccurs="0" name="jobInfo">

<xs:annotation>

<xs:documentation>

This is arbitrary information that can be added to the
job description by the UWS implementation.

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:any maxOccurs="unbounded" minOccurs="0" namespace="##any" processContents="lax"/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="version" type="uws:UWSVersion" use="optional">

<xs:annotation>

<xs:documentation>

note that this attribute is actually required by the 1.1 specification - however remains optional in the schema
for backwards compatibility. It will be formally required in the next major revision.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

Attribute Detail (all declarations; 1)

Type:	uws:UWSVersion
Use:	optional
Defined:	locally within (this) uws:JobSummary complexType

note that this attribute is actually required by the 1.1 specification - however remains optional in the schema for backwards compatibility. It will be formally required in the next major revision.

XML Source (see within schema source)

<xs:attribute name="version" type="uws:UWSVersion" use="optional">

<xs:annotation>

<xs:documentation>

note that this attribute is actually required by the 1.1 specification - however remains optional in the schema
for backwards compatibility. It will be formally required in the next major revision.

</xs:documentation>

</xs:annotation>

</xs:attribute>

Content Element Detail (all declarations; 14)

Type:	xs:dateTime, simple content
Defined:	locally within (this) uws:JobSummary complexType

The instant at which the job was created.

Note that the version 1.1 of the specification requires that this element be present. It is optional only in versions 1.x of the schema for backwards compatibility. 2.0+ versions of the schema will make this formally mandatory in an XML sense.

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="creationTime" nillable="false" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The instant at which the job was created.

</xs:documentation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	xs:dateTime, simple content
Nillable:	(can be declared as nil using xsi:nil attribute in instance XML documents)
Defined:	locally within (this) uws:JobSummary complexType

The time at which the whole job + records + results will be destroyed. returned at /{jobs}/{job-id}/destruction

XML Source (see within schema source)

<xs:element name="destruction" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The time at which the whole job + records + results
will be destroyed. returned at
/{jobs}/{job-id}/destruction

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	xs:dateTime, simple content
Nillable:	(can be declared as nil using xsi:nil attribute in instance XML documents)
Defined:	locally within (this) uws:JobSummary complexType

The instant at which the job finished execution

XML Source (see within schema source)

<xs:element name="endTime" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The instant at which the job finished execution

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	uws:ErrorSummary, complex content
Defined:	locally within (this) uws:JobSummary complexType

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="errorSummary" type="uws:ErrorSummary"/>

Type:	xs:int, simple content
Defined:	locally within (this) uws:JobSummary complexType

The duration (in seconds) for which the job should be allowed to run - a value of 0 is intended to mean unlimited - returned at /{jobs}/{job-id}/executionduration

XML Source (see within schema source)

<xs:element name="executionDuration" nillable="false" type="xs:int">

<xs:annotation>

<xs:documentation>

The duration (in seconds) for which the job should be
allowed to run - a value of 0 is intended to mean
unlimited - returned at
/{jobs}/{job-id}/executionduration

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	uws:JobIdentifier, simple content
Defined:	locally within (this) uws:JobSummary complexType

XML Source (see within schema source)

<xs:element name="jobId" type="uws:JobIdentifier"/>

Type:	anonymous, complex content
Defined:	locally within (this) uws:JobSummary complexType

This is arbitrary information that can be added to the job description by the UWS implementation.

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="jobInfo">

<xs:annotation>

<xs:documentation>

This is arbitrary information that can be added to the
job description by the UWS implementation.

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:any maxOccurs="unbounded" minOccurs="0" namespace="##any" processContents="lax"/>

</xs:sequence>

</xs:complexType>

</xs:element>

Type:	xs:string, simple content
Nillable:	(can be declared as nil using xsi:nil attribute in instance XML documents)
Defined:	locally within (this) uws:JobSummary complexType

the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL.

XML Source (see within schema source)

<xs:element name="ownerId" nillable="true" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	anonymous, complex content
Defined:	by reference within (this) uws:JobSummary complexType

The parameters to the job (where appropriate) can also be retrieved at /{jobs}/{job-id}/parameters

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" ref="uws:parameters">

<xs:annotation>

<xs:documentation>

The parameters to the job (where appropriate) can also
be retrieved at /{jobs}/{job-id}/parameters

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	uws:ExecutionPhase, simple content
Defined:	locally within (this) uws:JobSummary complexType

the execution phase - returned at /{jobs}/{job-id}/phase

XML Source (see within schema source)

<xs:element name="phase" type="uws:ExecutionPhase">

<xs:annotation>

<xs:documentation>

the execution phase - returned at
/{jobs}/{job-id}/phase

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	xs:dateTime, simple content
Nillable:	(can be declared as nil using xsi:nil attribute in instance XML documents)
Defined:	locally within (this) uws:JobSummary complexType

A Quote predicts when the job is likely to complete - returned at /{jobs}/{job-id}/quote "don't know" is encoded by setting to the XML null value xsi:nil="true"

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="quote" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

A Quote predicts when the job is likely to complete -
returned at /{jobs}/{job-id}/quote "don't know" is
encoded by setting to the XML null value
xsi:nil="true"

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	anonymous, complex content
Defined:	by reference within (this) uws:JobSummary complexType

The results for the job - can also be retrieved at /{jobs}/{job-id}/results

XML Source (see within schema source)

<xs:element ref="uws:results">

<xs:annotation>

<xs:documentation>

The results for the job - can also be retrieved at
/{jobs}/{job-id}/results

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	xs:string, simple content
Defined:	locally within (this) uws:JobSummary complexType

this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="runId" type="xs:string">

<xs:annotation>

<xs:documentation>

this is a client supplied identifier - the UWS system
does nothing other than to return it as part of the
description of the job

</xs:documentation>

</xs:annotation>

</xs:element>

Type:	xs:dateTime, simple content
Nillable:	(can be declared as nil using xsi:nil attribute in instance XML documents)
Defined:	locally within (this) uws:JobSummary complexType

The instant at which the job started execution.

XML Source (see within schema source)

<xs:element name="startTime" nillable="true" type="xs:dateTime">

<xs:annotation>

<xs:documentation>

The instant at which the job started execution.

</xs:documentation>

</xs:annotation>

</xs:element>

This XML schema documentation has been generated with DocFlex/XML RE 1.8.0 using DocFlex/XML XSDDoc 2.2.0 template set.

DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.

DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).

A commercial license for "DocFlex/XML XSDDoc" will allow you:

To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
To use certain features disabled in the free mode (such as the full documenting of substitution groups).
To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
To document local element components both globally and locally (similar to attributes).
To enable/disable reproducing of namespace prefixes.
To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
To use the same template to generate the incredible quality RTF documentation.
To document only selected XML schema components specified by name.
To remove this very advertisement text

Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!

But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!

Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!

To buy a license, please follow this link: http://www.filigris.com/shop/