complexType "vr:Interface"
Namespace:
http://www.ivoa.net/xml/VOResource/v1.0
Content:
complex, 2 attributes, 2 elements
Abstract:
(cannot be assigned directly to elements used in instance XML documents)
Defined:
globally in v1.0; see XML source
Includes:
definitions of 2 attributes, 2 elements
Used:
never
XML Representation Summary
<...
    role
 = 
 xs:NMTOKEN
    version
 = 
 xs:string : "1.0"
    >
   
Content: 
 accessURL+, securityMethod*
</...>
Content Model Elements (2):
accessURL (type vr:AccessURL),
securityMethod (type vr:SecurityMethod)
Known Direct Subtypes (10):
vg:OAIHTTP, vr:WebBrowser, vr:WebBrowser, vr:WebBrowser, vr:WebService, vr:WebService, vr:WebService, vs:ParamHTTP, vs:ParamHTTP, vs:ParamHTTP
Known Indirect Subtypes (1):
vg:OAISOAP
Annotation
Annotation 1 [src]:
A description of a service interface.
Annotation 2 [src]:
Since this type is abstract, one must use an Interface subclass to describe an actual interface.
Annotation 3 [src]:
Additional interface subtypes (beyond WebService and WebBrowser) are defined in the VODataService schema.
XML Source (see within schema source)
<xs:complexType abstract="true" name="Interface">
<xs:annotation>
<xs:documentation>
A description of a service interface.
</xs:documentation>
<xs:documentation>
Since this type is abstract, one must use an Interface subclass
to describe an actual interface.
</xs:documentation>
<xs:documentation>
Additional interface subtypes (beyond WebService and WebBrowser) are
defined in the VODataService schema.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="1" name="accessURL" type="vr:AccessURL">
<xs:annotation>
<xs:documentation>
The URL (or base URL) that a client uses to access the
service. How this URL is to be interpreted and used
depends on the specific Interface subclass
</xs:documentation>
<xs:documentation>
When more than one URL is given, each represents an
alternative (i.e. mirror) endpoint whose behavior is
identical to all the other accessURLs listed.
</xs:documentation>
<xs:documentation>
Editor's note: this element assumes that
all registered services are inherently web based.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="securityMethod" type="vr:SecurityMethod">
<xs:annotation>
<xs:documentation>
the mechanism the client must employ to gain secure
access to the service.
</xs:documentation>
<xs:documentation>
when more than one method is listed, each one must
be employed to gain access.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="1.0" name="version" type="xs:string">
<xs:annotation>
<xs:documentation>
The version of a standard interface specification that this
interface complies with. When the interface is
provided in the context of a Capability element, then
the standard being refered to is the one identified by
the Capability's standardID element. If the standardID
is not provided, the meaning of this attribute is
undefined.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="role" type="xs:NMTOKEN">
<xs:annotation>
<xs:documentation>
A tag name the identifies the role the interface plays
in the particular capability. If the value is equal to
"std" or begins with "std:", then the interface refers
to a standard interface defined by the standard
referred to by the capability's standardID attribute.
</xs:documentation>
<xs:documentation>
For an interface complying with some registered
standard (i.e. has a legal standardID), the role can be
match against interface roles enumerated in standard
resource record. The interface descriptions in
the standard record can provide default descriptions
so that such details need not be repeated here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
Attribute Detail (all declarations; 2)
role
Type:
xs:NMTOKEN
Use:
optional
Defined:
locally within (this) vr:Interface complexType
Annotation 1 [src]:
A tag name the identifies the role the interface plays in the particular capability. If the value is equal to "std" or begins with "std:", then the interface refers to a standard interface defined by the standard referred to by the capability's standardID attribute.
Annotation 2 [src]:
For an interface complying with some registered standard (i.e. has a legal standardID), the role can be match against interface roles enumerated in standard resource record. The interface descriptions in the standard record can provide default descriptions so that such details need not be repeated here.
XML Source (see within schema source)
<xs:attribute name="role" type="xs:NMTOKEN">
<xs:annotation>
<xs:documentation>
A tag name the identifies the role the interface plays
in the particular capability. If the value is equal to
"std" or begins with "std:", then the interface refers
to a standard interface defined by the standard
referred to by the capability's standardID attribute.
</xs:documentation>
<xs:documentation>
For an interface complying with some registered
standard (i.e. has a legal standardID), the role can be
match against interface roles enumerated in standard
resource record. The interface descriptions in
the standard record can provide default descriptions
so that such details need not be repeated here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
version
Type:
xs:string
Use:
optional
Default:
"1.0"
Defined:
locally within (this) vr:Interface complexType
The version of a standard interface specification that this interface complies with. When the interface is provided in the context of a Capability element, then the standard being refered to is the one identified by the Capability's standardID element. If the standardID is not provided, the meaning of this attribute is undefined.
XML Source (see within schema source)
<xs:attribute default="1.0" name="version" type="xs:string">
<xs:annotation>
<xs:documentation>
The version of a standard interface specification that this
interface complies with. When the interface is
provided in the context of a Capability element, then
the standard being refered to is the one identified by
the Capability's standardID element. If the standardID
is not provided, the meaning of this attribute is
undefined.
</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail (all declarations; 2)
accessURL
Type:
vr:AccessURL, simple content
Defined:
locally within (this) vr:Interface complexType
Annotation 1 [src]:
The URL (or base URL) that a client uses to access the service. How this URL is to be interpreted and used depends on the specific Interface subclass
Annotation 2 [src]:
When more than one URL is given, each represents an alternative (i.e. mirror) endpoint whose behavior is identical to all the other accessURLs listed.
Annotation 3 [src]:
Editor's note: this element assumes that all registered services are inherently web based.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="1" name="accessURL" type="vr:AccessURL">
<xs:annotation>
<xs:documentation>
The URL (or base URL) that a client uses to access the
service. How this URL is to be interpreted and used
depends on the specific Interface subclass
</xs:documentation>
<xs:documentation>
When more than one URL is given, each represents an
alternative (i.e. mirror) endpoint whose behavior is
identical to all the other accessURLs listed.
</xs:documentation>
<xs:documentation>
Editor's note: this element assumes that
all registered services are inherently web based.
</xs:documentation>
</xs:annotation>
</xs:element>
securityMethod
Type:
vr:SecurityMethod, empty content
Defined:
locally within (this) vr:Interface complexType
Annotation 1 [src]:
the mechanism the client must employ to gain secure access to the service.
Annotation 2 [src]:
when more than one method is listed, each one must be employed to gain access.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="securityMethod" type="vr:SecurityMethod">
<xs:annotation>
<xs:documentation>
the mechanism the client must employ to gain secure
access to the service.
</xs:documentation>
<xs:documentation>
when more than one method is listed, each one must
be employed to gain access.
</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/