javax.wsdl

Interface Message

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

public interface Message
extends java.io.Serializable, ElementExtensible

This interface describes a message used for communication with an operation.
Authors:
Paul Fremantle
Nirmal Mukhi
Matthew J. Duftler

Method Summary

void
addPart(Part part)
Add a part to this message.
Element
getDocumentationElement()
Get the documentation element.
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)

Methods inherited from interface javax.wsdl.extensions.ElementExtensible

addExtensibilityElement, getExtensibilityElements

Method Details

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