javax.wsdl

Interface Message

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

public interface Message
extends WSDLElement

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

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.
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()
Part
removePart(String name)
Remove the specified part.
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

Methods inherited from interface javax.wsdl.extensions.ElementExtensible

addExtensibilityElement, getExtensibilityElements, removeExtensibilityElement

Methods inherited from interface javax.wsdl.WSDLElement

getDocumentationElement, setDocumentationElement

Method Details

addPart

public void addPart(Part part)
Add a part to this message.
Parameters:
part - the part to be added

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()

removePart

public Part removePart(String name)
Remove the specified part.
Parameters:
name - the name of the part to be removed.
Returns:
the part which was removed

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