javax.wsdl
Interface Message

All Superinterfaces:
AttributeExtensible, java.io.Serializable
All Known Implementing Classes:
MessageImpl

public interface Message
extends java.io.Serializable, AttributeExtensible

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

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

Field Summary
 
Fields inherited from interface javax.wsdl.extensions.AttributeExtensible
LIST_OF_QNAMES_TYPE, LIST_OF_STRINGS_TYPE, NO_DECLARED_TYPE, QNAME_TYPE, STRING_TYPE
 
Method Summary
 void addPart(Part part)
          Add a part to this message.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 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 setQName(QName name)
          Set the name of this message.
 void setUndefined(boolean isUndefined)
           
 
Methods inherited from interface javax.wsdl.extensions.AttributeExtensible
getExtensionAttribute, getExtensionAttributes, getNativeAttributeNames, setExtensionAttribute
 

Method Detail

setQName

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

Parameters:
name - the desired name

getQName

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

Returns:
the message name

addPart

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

Parameters:
part - the part to be added

getPart

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

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.


getOrderedParts

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

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.

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

setUndefined

public void setUndefined(boolean isUndefined)

isUndefined

public boolean isUndefined()


Copyright ? 2003 IBM. All Rights Reserved.