javax.wsdl
Interface Part

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
PartImpl

public interface Part
extends java.io.Serializable

This interface represents a message part and contains the part's name, elementName, typeName, and any extensibility attributes.

Author:
Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler

Method Summary
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 QName getElementName()
           
 QName getExtensionAttribute(QName name)
          Retrieve an extension attribute from this part.
 java.util.Map getExtensionAttributes()
          Get the map containing all the extension attributes defined on this part.
 java.lang.String getName()
          Get the name of this part.
 QName getTypeName()
           
 void setDocumentationElement(org.w3c.dom.Element docEl)
          Set the documentation element for this document.
 void setElementName(QName elementName)
           
 void setExtensionAttribute(QName name, QName value)
          Set an extension attribute on this part.
 void setName(java.lang.String name)
          Set the name of this part.
 void setTypeName(QName typeName)
           
 

Method Detail

setName

public void setName(java.lang.String name)
Set the name of this part.
Parameters:
name - the desired name

getName

public java.lang.String getName()
Get the name of this part.
Returns:
the part name

setElementName

public void setElementName(QName elementName)

getElementName

public QName getElementName()

setTypeName

public void setTypeName(QName typeName)

getTypeName

public QName getTypeName()

setExtensionAttribute

public void setExtensionAttribute(QName name,
                                  QName value)
Set an extension attribute on this part. Pass in a null value to remove an extension attribute.
Parameters:
name - the extension attribute name
value - the extension attribute value
See Also:
getExtensionAttribute(javax.xml.namespace.QName), getExtensionAttributes()

getExtensionAttribute

public QName getExtensionAttribute(QName name)
Retrieve an extension attribute from this part. If the extension attribute is not defined, null is returned.
Parameters:
name - the extension attribute name
Returns:
the value of the extension attribute, or null if it is not defined
See Also:
setExtensionAttribute(javax.xml.namespace.QName, javax.xml.namespace.QName), getExtensionAttributes()

getExtensionAttributes

public java.util.Map getExtensionAttributes()
Get the map containing all the extension attributes defined on this part. The keys are the qnames of the attributes.
Returns:
a map containing all the extension attributes defined on this part
See Also:
setExtensionAttribute(javax.xml.namespace.QName, javax.xml.namespace.QName), getExtensionAttribute(javax.xml.namespace.QName)

setDocumentationElement

public void setDocumentationElement(org.w3c.dom.Element docEl)
Set the documentation element for this document. This dependency on org.w3c.dom.Element should eventually be removed when a more appropriate way of representing this information is employed.
Parameters:
docEl - the documentation element

getDocumentationElement

public org.w3c.dom.Element getDocumentationElement()
Get the documentation element. This dependency on org.w3c.dom.Element should eventually be removed when a more appropriate way of representing this information is employed.
Returns:
the documentation element


Copyright © 2003 IBM. All Rights Reserved.