com.ibm.wsdl

Class MessageImpl

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.

Authors:
Paul Fremantle
Nirmal Mukhi
Matthew J. Duftler

Field Summary

protected List
additionOrderOfParts
protected Element
docEl
protected List
extElements
protected boolean
isUndefined
protected QName
name
protected Map
parts
static long
serialVersionUID

Method Summary

void
addExtensibilityElement(ExtensibilityElement extElement)
Add an extensibility element.
void
addPart(Part part)
Add a part to this message.
Element
getDocumentationElement()
Get the documentation element.
List
getExtensibilityElements()
Get all the extensibility elements defined here.
List
getOrderedParts(List partOrder)
Get an ordered list of parts as specified by the partOrder argument.
Part
getPart(String name)
Get the specified part.
Map
getParts()
Get all the parts defined here.
QName
getQName()
Get the name of this message.
boolean
isUndefined()
void
setDocumentationElement(Element docEl)
Set the documentation element for this document.
void
setQName(QName name)
Set the name of this message.
void
setUndefined(boolean isUndefined)
String
toString()

Field Details

additionOrderOfParts

protected List additionOrderOfParts


docEl

protected Element docEl


extElements

protected List extElements


isUndefined

protected boolean isUndefined


name

protected QName name


parts

protected Map parts


serialVersionUID

public static final long serialVersionUID

Field Value:
1L

Method Details

addExtensibilityElement

public void addExtensibilityElement(ExtensibilityElement extElement)
Add an extensibility element.
Specified by:
addExtensibilityElement in interface ElementExtensible

Parameters:
extElement - the extensibility element to be added


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


getDocumentationElement

public 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


getExtensibilityElements

public List getExtensibilityElements()
Get all the extensibility elements defined here.
Specified by:
getExtensibilityElements in interface ElementExtensible


getOrderedParts

public List getOrderedParts(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


getPart

public Part getPart(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 Map getParts()
Get all the parts defined here.
Specified by:
getParts in interface Message


getQName

public QName getQName()
Get the name of this message.
Specified by:
getQName in interface Message

Returns:
the message name


isUndefined

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


setDocumentationElement

public void setDocumentationElement(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


setQName

public void setQName(QName name)
Set the name of this message.
Specified by:
setQName in interface Message

Parameters:
name - the desired name


setUndefined

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


toString

public String toString()


Copyright B) 2003,2005 IBM. All Rights Reserved.