org.netbeans.modules.bpel.model.api
Interface Import

All Superinterfaces:
BpelContainer, BpelEntity, Component<BpelEntity>, DocumentComponent<BpelEntity>, ExtensibleElements, NamespaceSpec
All Known Implementing Classes:
ImportImpl

public interface Import
extends ExtensibleElements, NamespaceSpec

Author:
ads

The <import> element is used within a WS-BPEL process to explicitly indicate a dependency on external XML Schema or WSDL definitions. Any number of <import> elements may appear as initial children of the <process> element, before any other child element. Each <import> element contains a mandatory and two optional attributes.

  • "namespace". The namespace attribute specifies an absolute URI that identifies the imported definitions. This attribute is optional. An import element without  a namespace attribute indicates that external definitions are in use which are not namespace qualified.
  • "location". The location attribute contains a URI indicating the location of a document that contains relevant definitions in the namespace specified. The location URI may be a relative URI, following the usual rules for resolution of the URI base (XML Base and RFC 2396). The location attribute is optional. An import element without a location attribute indicates that external definitions are used by the process but makes no statement about where those definitions may be found. The document located at the location URI MUST identify the definitions it contains with a URI matching the URI indicated by the namespace attribute. The location attribute is a hint and that the BPEL Processor is not required to retrieve the document being imported from the specified location.
  • "importType". The importType attribute identifies the type of document being imported by providing an absolute URI that identifies the encoding language used in the document. The value of the importType attribute MUST be set to "http://www.w3.org/2001/XMLSchema"; when importing XML Schema 1.0 documents, and to "http://schemas.xmlsoap.org/wsdl/"; when importing WSDL 1.1 documents. Note: other importType URI values MAY be used here.
  • Observe that according to these rules, it is permissible to have an import element without namespace and location attributes, and only containing an importType attribute. Such an import element indicates that external definitions of the indicated type are in use which are not namespace qualified, and makes no statement about where those definitions may be found.

    A BPEL process definition MUST import all XML Schema and WSDL definitions it uses. This includes all XML Schema type and element definitions, all WSLD port types and message types as well as property and property alias definitions used by the process. In order to support the use of definitions from namespaces spanning multiple documents, a BPEL process MAY include more than one import declarations for the same namespace and importType, provided that those declarations include different location values. Import elements are conceptually unordered. It is an error if the imported documents contain conflicting definitions of a component used by the importing process definition (as could be caused, for example, when the XSD redefinition mechanism is used).

    Java class for tImport complex type.

    The following schema fragment specifies the expected content contained within this class.

       <complexType name="tImport">
         <complexContent>
           <extension base="{http://docs.oasis-open.org/wsbpel/2.0/process/executable}tExtensibleElements">
             <attribute name="importType" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
             <attribute name="location" use="optional" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
             <attribute name="namespace" use="optional" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
           </extension>
         </complexContent>
       </complexType>
     

    Field Summary
    static java.lang.String IMPORT_TYPE
               
    static java.lang.String LOCATION
               
    static java.lang.String SCHEMA_IMPORT_TYPE
              This type should be used for xsd document.
    static java.lang.String WSDL_IMPORT_TYPE
              This type should be used for wsdl document.
     
    Fields inherited from interface org.netbeans.modules.bpel.model.api.BpelEntity
    BUSINESS_PROCESS_1_1_NS_URI, BUSINESS_PROCESS_DRAFT_NS_URI, BUSINESS_PROCESS_NS_URI
     
    Fields inherited from interface org.netbeans.modules.xml.xam.dom.DocumentComponent
    TEXT_CONTENT_PROPERTY
     
    Fields inherited from interface org.netbeans.modules.bpel.model.api.NamespaceSpec
    NAMESPACE
     
    Method Summary
     java.lang.String getImportType()
              Getter for ""importType" attribute.
     java.lang.String getLocation()
              Getter for "location" attribute.
     void removeLocation()
              Removes "location" attribute.
     void removeNamespace()
              Removes "namespace" attribute.
     void setImportType(java.lang.String value)
              Setter for ""importType" attribute.
     void setLocation(java.lang.String value)
              Setter for "location" attribute.
     
    Methods inherited from interface org.netbeans.modules.bpel.model.api.ExtensibleElements
    addDocumentation, addExtensionEntity, getDocumentation, getDocumentation, getDocumentations, getExtensionChildren, insertDocumentation, removeDocumentation, removeDocumentation, setDocumentation, setDocumentation, setDocumentations, sizeOfDocumentations
     
    Methods inherited from interface org.netbeans.modules.bpel.model.api.BpelContainer
    indexOf, remove
     
    Methods inherited from interface org.netbeans.modules.bpel.model.api.BpelEntity
    accept, accept, copy, cut, getBpelModel, getCookie, getElementType, getNamespaceContext, getParent, getUID, removeCookie, setCookie
     
    Methods inherited from interface org.netbeans.modules.xml.xam.dom.DocumentComponent
    findAttributePosition, findChildComponent, findPosition, getAttribute, getPeer, isInDocumentModel, referencesSameNode, setAttribute
     
    Methods inherited from interface org.netbeans.modules.xml.xam.Component
    canPaste, copy, getChildren, getChildren, getChildren, getModel
     
    Methods inherited from interface org.netbeans.modules.bpel.model.api.NamespaceSpec
    getNamespace, setNamespace
     

    Field Detail

    LOCATION

    static final java.lang.String LOCATION
    See Also:
    Constant Field Values

    IMPORT_TYPE

    static final java.lang.String IMPORT_TYPE
    See Also:
    Constant Field Values

    SCHEMA_IMPORT_TYPE

    static final java.lang.String SCHEMA_IMPORT_TYPE
    This type should be used for xsd document.

    See Also:
    Constant Field Values

    WSDL_IMPORT_TYPE

    static final java.lang.String WSDL_IMPORT_TYPE
    This type should be used for wsdl document.

    See Also:
    Constant Field Values
    Method Detail

    getLocation

    java.lang.String getLocation()
    Getter for "location" attribute.

    Returns:
    "location" attribute value.

    setLocation

    void setLocation(java.lang.String value)
                     throws VetoException
    Setter for "location" attribute.

    Parameters:
    value - New "location" attribute value.
    Throws:
    VetoException - Will be thrown if value is not acceptable as value here.

    removeLocation

    void removeLocation()
    Removes "location" attribute.


    getImportType

    java.lang.String getImportType()
    Getter for ""importType" attribute.

    Returns:
    "importType" attribute value.

    setImportType

    void setImportType(java.lang.String value)
                       throws VetoException
    Setter for ""importType" attribute.

    Parameters:
    value - New "importType" attribute value.
    Throws:
    VetoException - Will be thrown if value is not acceptable as value here.

    removeNamespace

    void removeNamespace()
    Removes "namespace" attribute.