Package javax.wsdl
Interface Message
-
- All Superinterfaces:
AttributeExtensible,ElementExtensible,java.io.Serializable,WSDLElement
- All Known Implementing Classes:
MessageImpl
public interface Message extends WSDLElement
This interface describes a message used for communication with an operation.- Author:
- Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler
-
-
Field Summary
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddPart(Part part)Add a part to this message.java.util.ListgetOrderedParts(java.util.List partOrder)Get an ordered list of parts as specified by the partOrder argument.PartgetPart(java.lang.String name)Get the specified part.java.util.MapgetParts()Get all the parts defined here.QNamegetQName()Get the name of this message.booleanisUndefined()PartremovePart(java.lang.String name)Remove the specified part.voidsetQName(QName name)Set the name of this message.voidsetUndefined(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 Detail
-
setQName
void setQName(QName name)
Set the name of this message.- Parameters:
name- the desired name
-
getQName
QName getQName()
Get the name of this message.- Returns:
- the message name
-
addPart
void addPart(Part part)
Add a part to this message.- Parameters:
part- the part to be added
-
getPart
Part getPart(java.lang.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
-
removePart
Part removePart(java.lang.String name)
Remove the specified part.- Parameters:
name- the name of the part to be removed.- Returns:
- the part which was removed
-
getParts
java.util.Map getParts()
Get all the parts defined here.
-
getOrderedParts
java.util.List getOrderedParts(java.util.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
-
setUndefined
void setUndefined(boolean isUndefined)
-
isUndefined
boolean isUndefined()
-
-