/[volute]/trunk/projects/grid/uws/doc/UWS.xsd
ViewVC logotype

Diff of /trunk/projects/grid/uws/doc/UWS.xsd

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3004 by harripa@gmail.com, Mon Oct 20 07:45:19 2014 UTC revision 3005 by harripa@gmail.com, Thu Jun 18 07:03:38 2015 UTC
# Line 2  Line 2 
2     <!-- $Revision$ $Date$  $HeadURL$ -->     <!-- $Revision$ $Date$  $HeadURL$ -->
3     <!-- UWS schema - Paul Harrison May 2008 -->     <!-- UWS schema - Paul Harrison May 2008 -->
4  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
5     targetNamespace="http://www.ivoa.net/xml/UWS/v1.1" xmlns:uws="http://www.ivoa.net/xml/UWS/v1.1"     targetNamespace="http://www.ivoa.net/xml/UWS/v1.0" xmlns:uws="http://www.ivoa.net/xml/UWS/v1.0"
6     xmlns:xlink="http://www.w3.org/1999/xlink" elementFormDefault="qualified"     xmlns:xlink="http://www.w3.org/1999/xlink" elementFormDefault="qualified"
7     attributeFormDefault="unqualified"     attributeFormDefault="unqualified"
8  >  >
 <!--  
    <xs:import namespace="http://www.w3.org/1999/xlink"  
       schemaLocation="../../../stc/STC/v1.30/XLINK.xsd" />  
  -->    
9        <xs:import namespace="http://www.w3.org/1999/xlink"        <xs:import namespace="http://www.w3.org/1999/xlink"
10        schemaLocation="http://www.ivoa.net/xml/Xlink/xlink.xsd"/>        schemaLocation="http://www.ivoa.net/xml/Xlink/xlink.xsd"/>
11        
# Line 122  Line 118 
118     </xs:simpleType>     </xs:simpleType>
119     <xs:complexType name="JobSummary">     <xs:complexType name="JobSummary">
120        <xs:annotation>        <xs:annotation>
121           <xs:documentation>The complete representation of the state           <xs:documentation>
122              of a job</xs:documentation>              The complete representation of the state of a job
123             </xs:documentation>
124        </xs:annotation>        </xs:annotation>
125        <xs:sequence>        <xs:sequence>
126           <xs:element name="jobId" type="uws:JobIdentifier" />           <xs:element name="jobId" type="uws:JobIdentifier" />
# Line 131  Line 128 
128              minOccurs="0"              minOccurs="0"
129           >           >
130              <xs:annotation>              <xs:annotation>
131                 <xs:documentation> this is a client supplied identifier -                 <xs:documentation>
132                    the UWS system does nothing other than to return it as                    this is a client supplied identifier - the UWS system
133                    part of the description of the job</xs:documentation>                    does nothing other than to return it as part of the
134                      description of the job
135                   </xs:documentation>
136              </xs:annotation>              </xs:annotation>
137           </xs:element>           </xs:element>
138           <xs:element name="ownerId" type="xs:string"           <xs:element name="ownerId" type="xs:string" nillable="true">
             nillable="true"  
          >  
139              <xs:annotation>              <xs:annotation>
140                 <xs:documentation>the owner (creator) of the job -                 <xs:documentation>
141                    this should be expressed as a string that can be                    the owner (creator) of the job - this should be
142                    parsed in accordance with IVOA security standards. If                    expressed as a string that can be parsed in accordance
143                    there was no authenticated job creator then this                    with IVOA security standards. If there was no
144                    should be set to NULL.</xs:documentation>                    authenticated job creator then this should be set to
145                      NULL.
146                   </xs:documentation>
147              </xs:annotation>              </xs:annotation>
148           </xs:element>           </xs:element>
149           <xs:element name="phase" type="uws:ExecutionPhase">           <xs:element name="phase" type="uws:ExecutionPhase">
150              <xs:annotation>              <xs:annotation>
151                 <xs:documentation> the execution phase - returned at                 <xs:documentation>
152                    /(jobs)/(jobid)/phase</xs:documentation>                    the execution phase - returned at
153                      /(jobs)/(jobid)/phase
154                   </xs:documentation>
155              </xs:annotation>              </xs:annotation>
156           </xs:element>           </xs:element>
157           <xs:element name="quote" type="xs:dateTime"           <xs:element name="quote" type="xs:dateTime" nillable="true"
158              nillable="true" maxOccurs="1" minOccurs="0"              maxOccurs="1" minOccurs="0"
159           >           >
160              <xs:annotation>              <xs:annotation>
161                 <xs:documentation> A Quote predicts when the job is likely to complete - returned at /(jobs)/(jobid)/quote                 <xs:documentation>
162                    "don't know" is encoded by setting to the XML null value xsi:nil="true"</xs:documentation>                    A Quote predicts when the job is likely to complete -
163                      returned at /(jobs)/(jobid)/quote "don't know" is
164                      encoded by setting to the XML null value
165                      xsi:nil="true"
166                   </xs:documentation>
167              </xs:annotation>              </xs:annotation>
168           </xs:element>           </xs:element>
169           <xs:element name="startTime" type="xs:dateTime"           <xs:element name="startTime" type="xs:dateTime"
170              nillable="true" >              nillable="true"
171             >
172              <xs:annotation>              <xs:annotation>
173                 <xs:documentation>The instant at which the job started execution.</xs:documentation>                 <xs:documentation>
174              </xs:annotation></xs:element>                    The instant at which the job started execution.
175                   </xs:documentation>
176                </xs:annotation>
177             </xs:element>
178           <xs:element name="endTime" type="xs:dateTime"           <xs:element name="endTime" type="xs:dateTime"
179              nillable="true" >              nillable="true"
180             >
181              <xs:annotation>              <xs:annotation>
182                 <xs:documentation>The instant at which the job finished execution</xs:documentation>                 <xs:documentation>
183              </xs:annotation></xs:element>                    The instant at which the job finished execution
184                   </xs:documentation>
185                </xs:annotation>
186             </xs:element>
187           <xs:element name="executionDuration" type="xs:int"           <xs:element name="executionDuration" type="xs:int"
188              nillable="false"              nillable="false"
189           >           >
             <!-- TODO look if xs:duration here has any benefits -->  
190              <xs:annotation>              <xs:annotation>
191                 <xs:documentation> The duration (in seconds) for which                 <xs:documentation>
192                    the job should be allowed to run - a value of 0 is                    The duration (in seconds) for which the job should be
193                    intended to mean unlimited - returned at                    allowed to run - a value of 0 is intended to mean
194                    /(jobs)/(jobid)/executionduration</xs:documentation>                    unlimited - returned at
195                      /(jobs)/(jobid)/executionduration
196                   </xs:documentation>
197              </xs:annotation>              </xs:annotation>
198           </xs:element>           </xs:element>
199           <xs:element name="destruction" type="xs:dateTime"           <xs:element name="destruction" type="xs:dateTime"
200              nillable="true"              nillable="true"
201           >           >
202              <xs:annotation>              <xs:annotation>
203                 <xs:documentation> The time at which the whole job +                 <xs:documentation>
204                    records + results will be destroyed. returned at                    The time at which the whole job + records + results
205                    /(jobs)/(jobid)/destruction</xs:documentation>                    will be destroyed. returned at
206                      /(jobs)/(jobid)/destruction
207                   </xs:documentation>
208              </xs:annotation>              </xs:annotation>
209           </xs:element>           </xs:element>
210           <xs:element ref="uws:parameters" maxOccurs="1"           <xs:element ref="uws:parameters" maxOccurs="1" minOccurs="0">
211              minOccurs="0"              <xs:annotation>
212           >                 <xs:documentation>
213                  <xs:annotation>                    The parameters to the job (where appropriate) can also
214                     <xs:documentation>The parameters to the job (where appropriate)                    be retrieved at /(jobs)/(jobid)/parameters
215  can also be retrieved at /(jobs)/(jobid)/parameters</xs:documentation>                 </xs:documentation>
216                  </xs:annotation>              </xs:annotation>
217           </xs:element>           </xs:element>
218           <xs:element ref="uws:results">           <xs:element ref="uws:results">
219              <xs:annotation>              <xs:annotation>
220                 <xs:documentation>The results for the job - can also be retrieved at /(jobs)/(jobid)/results</xs:documentation>                 <xs:documentation>
221              </xs:annotation></xs:element>                    The results for the job - can also be retrieved at
222                      /(jobs)/(jobid)/results
223                   </xs:documentation>
224                </xs:annotation>
225             </xs:element>
226           <xs:element name="errorSummary" type="uws:ErrorSummary"           <xs:element name="errorSummary" type="uws:ErrorSummary"
227              maxOccurs="1" minOccurs="0"              maxOccurs="1" minOccurs="0"
228           >           >
229           </xs:element>           </xs:element>
230           <xs:element name="jobInfo" maxOccurs="1" minOccurs="0">           <xs:element name="jobInfo" maxOccurs="1" minOccurs="0">
231              <xs:annotation>              <xs:annotation>
232                 <xs:documentation> This is arbitrary information that can                 <xs:documentation>
233                    be added to the job description by the UWS                    This is arbitrary information that can be added to the
234                    implementation.</xs:documentation>                    job description by the UWS implementation.
235                   </xs:documentation>
236              </xs:annotation>              </xs:annotation>
237              <xs:complexType>              <xs:complexType>
238                 <xs:sequence>                 <xs:sequence>
239                    <xs:any namespace="##any" processContents="lax"                    <xs:any namespace="##any" processContents="lax"
240                       minOccurs="0" maxOccurs="unbounded" />                       minOccurs="0" maxOccurs="unbounded"
241                      />
242                 </xs:sequence>                 </xs:sequence>
243              </xs:complexType>              </xs:complexType>
244           </xs:element>           </xs:element>
245        </xs:sequence>        </xs:sequence>
246          <xs:attribute name="version" type="uws:UWSVersion" use="required"/>
247     </xs:complexType>     </xs:complexType>
248     <xs:simpleType name="JobIdentifier">     <xs:simpleType name="JobIdentifier">
249        <xs:annotation>        <xs:annotation>
# Line 229  Line 252 
252        </xs:annotation>        </xs:annotation>
253        <xs:restriction base="xs:string" />        <xs:restriction base="xs:string" />
254     </xs:simpleType>     </xs:simpleType>
255       <xs:simpleType name="UWSVersion">
256          <xs:annotation>
257             <xs:documentation>The version of the UWS standard that the server complies with.
258             </xs:documentation>
259          </xs:annotation>
260          <xs:restriction base="xs:string" />
261       </xs:simpleType>
262     <xs:element name="job" type="uws:JobSummary">     <xs:element name="job" type="uws:JobSummary">
263        <xs:annotation>        <xs:annotation>
264           <xs:documentation> This is the information that is returned           <xs:documentation> This is the information that is returned
# Line 240  Line 270 
270        <xs:annotation>        <xs:annotation>
271           <xs:documentation> The list of job references returned at           <xs:documentation> The list of job references returned at
272              /(jobs)</xs:documentation>              /(jobs)</xs:documentation>
273              <xs:documentation>The list presented may be affected by the current securiity context and may be filtered</xs:documentation>
274        </xs:annotation>        </xs:annotation>
275        <xs:complexType>        <xs:complexType>
          <xs:annotation>  
             <xs:documentation> ISSUE - do we want to have any sort of  
                paging or selection mechanism in case the job list gets  
                very large? Or is that an unnecessary complication...  
             </xs:documentation>  
          </xs:annotation>  
276           <xs:sequence>           <xs:sequence>
277              <xs:element name="jobref" type="uws:ShortJobDescription"              <xs:element name="jobref" type="uws:ShortJobDescription"
278                 maxOccurs="unbounded" minOccurs="0"                 maxOccurs="unbounded" minOccurs="0"
279              ></xs:element>              >
280                </xs:element>
281           </xs:sequence>           </xs:sequence>
282             <xs:attribute name="version" type="uws:UWSVersion" use="required"/>
283        </xs:complexType>        </xs:complexType>
284     </xs:element>     </xs:element>
285     <xs:complexType name="ResultReference" mixed="false">     <xs:complexType name="ResultReference" mixed="false">
286        <xs:annotation>        <xs:annotation>
287           <xs:documentation> A reference to a UWS result. If the           <xs:documentation> A reference to a UWS result.
288           </xs:documentation>           </xs:documentation>
289        </xs:annotation>        </xs:annotation>
290        <xs:attribute name="id" type="xs:string" use="required"></xs:attribute>        <xs:attribute name="id" type="xs:string" use="required"></xs:attribute>

Legend:
Removed from v.3004  
changed lines
  Added in v.3005

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26