com.ibm.wsdl
Class MessageImpl

java.lang.Object
  extended bycom.ibm.wsdl.MessageImpl
All Implemented Interfaces:
ElementExtensible, 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.List extElements
           
protected  boolean isUndefined
           
protected  QName name
           
protected  java.util.Map parts
           
static long serialVersionUID
           
 
Constructor Summary
MessageImpl()
           
 
Method Summary
 void addExtensibilityElement(ExtensibilityElement extElement)
          Add an extensibility element.
 void addPart(Part part)
          Add a part to this message.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 java.util.List getExtensibilityElements()
          Get all the extensibility elements defined here.
 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)
           
 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

extElements

protected java.util.List extElements

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

addExtensibilityElement

public void addExtensibilityElement(ExtensibilityElement extElement)
Add an extensibility element.

Specified by:
addExtensibilityElement in interface ElementExtensible
Parameters:
extElement - the extensibility element to be added

getExtensibilityElements

public java.util.List getExtensibilityElements()
Get all the extensibility elements defined here.

Specified by:
getExtensibilityElements in interface ElementExtensible

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,2005 IBM. All Rights Reserved.