com.ibm.wsdl
Class MessageImpl

java.lang.Object
  extended bycom.ibm.wsdl.MessageImpl
All Implemented Interfaces:
AttributeExtensible, Message, java.io.Serializable

public class MessageImpl
extends java.lang.Object
implements Message

This class describes a message used for communication with an operation.

Author:
Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler
See Also:
Serialized Form

Field Summary
protected  java.util.List additionOrderOfParts
           
protected  org.w3c.dom.Element docEl
           
protected  java.util.Map extensionAttributes
           
protected  boolean isUndefined
           
protected  QName name
           
protected  java.util.List nativeAttributeNames
           
protected  java.util.Map parts
           
static long serialVersionUID
           
 
Fields inherited from interface javax.wsdl.extensions.AttributeExtensible
LIST_OF_QNAMES_TYPE, LIST_OF_STRINGS_TYPE, NO_DECLARED_TYPE, QNAME_TYPE, STRING_TYPE
 
Constructor Summary
MessageImpl()
           
 
Method Summary
 void addPart(Part part)
          Add a part to this message.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 java.lang.Object getExtensionAttribute(QName name)
          Retrieve an extension attribute from this element.
 java.util.Map getExtensionAttributes()
          Get the map containing all the extension attributes defined on this element.
 java.util.List getNativeAttributeNames()
          Get the list of local attribute names defined for this element in the WSDL specification.
 java.util.List getOrderedParts(java.util.List partOrder)
          Get an ordered list of parts as specified by the partOrder argument.
 Part getPart(java.lang.String name)
          Get the specified part.
 java.util.Map getParts()
          Get all the parts defined here.
 QName getQName()
          Get the name of this message.
 boolean isUndefined()
           
 void setDocumentationElement(org.w3c.dom.Element docEl)
          Set the documentation element for this document.
 void setExtensionAttribute(QName name, java.lang.Object value)
          Set an extension attribute on this element.
 void setQName(QName name)
          Set the name of this message.
 void setUndefined(boolean isUndefined)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

parts

protected java.util.Map parts

additionOrderOfParts

protected java.util.List additionOrderOfParts

name

protected QName name

docEl

protected org.w3c.dom.Element docEl

extensionAttributes

protected java.util.Map extensionAttributes

nativeAttributeNames

protected java.util.List nativeAttributeNames

isUndefined

protected boolean isUndefined

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

MessageImpl

public MessageImpl()
Method Detail

setQName

public void setQName(QName name)
Set the name of this message.

Specified by:
setQName in interface Message
Parameters:
name - the desired name

getQName

public QName getQName()
Get the name of this message.

Specified by:
getQName in interface Message
Returns:
the message name

addPart

public void addPart(Part part)
Add a part to this message.

Specified by:
addPart in interface Message
Parameters:
part - the part to be added

getPart

public Part getPart(java.lang.String name)
Get the specified part.

Specified by:
getPart in interface Message
Parameters:
name - the name of the desired part.
Returns:
the corresponding part, or null if there wasn't any matching part

getParts

public java.util.Map getParts()
Get all the parts defined here.

Specified by:
getParts in interface Message

getOrderedParts

public java.util.List getOrderedParts(java.util.List partOrder)
Get an ordered list of parts as specified by the partOrder argument.

Specified by:
getOrderedParts in interface Message
Parameters:
partOrder - a list of strings, with each string referring to a part by its name. If this argument is null, the parts are returned in the order in which they were added to the message.
Returns:
the list of parts

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.

Specified by:
setDocumentationElement in interface Message
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.

Specified by:
getDocumentationElement in interface Message
Returns:
the documentation element

setExtensionAttribute

public void setExtensionAttribute(QName name,
                                  java.lang.Object value)
Set an extension attribute on this element. Pass in a null value to remove an extension attribute.

Specified by:
setExtensionAttribute in interface AttributeExtensible
Parameters:
name - the extension attribute name
value - the extension attribute value. Can be a String, a QName, a List of Strings, or a List of QNames.
See Also:
getExtensionAttribute(javax.xml.namespace.QName), getExtensionAttributes(), ExtensionRegistry#registerExtensionAttributeType, ExtensionRegistry#queryExtensionAttributeType

getExtensionAttribute

public java.lang.Object getExtensionAttribute(QName name)
Retrieve an extension attribute from this element. If the extension attribute is not defined, null is returned.

Specified by:
getExtensionAttribute in interface AttributeExtensible
Parameters:
name - the extension attribute name
Returns:
the value of the extension attribute, or null if it is not defined. Can be a String, a QName, a List of Strings, or a List of QNames.
See Also:
setExtensionAttribute(javax.xml.namespace.QName, java.lang.Object), getExtensionAttributes(), ExtensionRegistry#registerExtensionAttributeType, ExtensionRegistry#queryExtensionAttributeType

getExtensionAttributes

public java.util.Map getExtensionAttributes()
Get the map containing all the extension attributes defined on this element. The keys are the qnames of the attributes.

Specified by:
getExtensionAttributes in interface AttributeExtensible
Returns:
a map containing all the extension attributes defined on this element
See Also:
setExtensionAttribute(javax.xml.namespace.QName, java.lang.Object), getExtensionAttribute(javax.xml.namespace.QName)

getNativeAttributeNames

public java.util.List getNativeAttributeNames()
Get the list of local attribute names defined for this element in the WSDL specification.

Specified by:
getNativeAttributeNames in interface AttributeExtensible
Returns:
a List of Strings, one for each local attribute name

setUndefined

public void setUndefined(boolean isUndefined)
Specified by:
setUndefined in interface Message

isUndefined

public boolean isUndefined()
Specified by:
isUndefined in interface Message

toString

public java.lang.String toString()


Copyright ? 2003 IBM. All Rights Reserved.