javax.wsdl

Interface Message

public interface Message extends Serializable, ElementExtensible

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

Author: Paul Fremantle Nirmal Mukhi Matthew J. Duftler

Method Summary
voidaddPart(Part part)
Add a part to this message.
ElementgetDocumentationElement()
Get the documentation element.
ListgetOrderedParts(List partOrder)
Get an ordered list of parts as specified by the partOrder argument.
PartgetPart(String name)
Get the specified part.
MapgetParts()
Get all the parts defined here.
QNamegetQName()
Get the name of this message.
booleanisUndefined()
voidsetDocumentationElement(Element docEl)
Set the documentation element for this document.
voidsetQName(QName name)
Set the name of this message.
voidsetUndefined(boolean isUndefined)

Method Detail

addPart

public void addPart(Part part)
Add a part to this 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.

Returns: the documentation element

getOrderedParts

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

getPart

public Part getPart(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 Map getParts()
Get all the parts defined here.

getQName

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

Returns: the message name

isUndefined

public boolean isUndefined()

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.

Parameters: docEl the documentation element

setQName

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

Parameters: name the desired name

setUndefined

public void setUndefined(boolean isUndefined)
Copyright © 2003,2005 IBM. All Rights Reserved.