org.codehaus.enunciate.contract.jaxws
Interface WebMessage

All Known Implementing Classes:

RequestWrapper, ResponseWrapper, RPCInputMessage, RPCOutputMessage, WebFault, WebParam, WebResult

public interface WebMessage

A web message. This could in include rpc-style parameters, web faults, header parameters, or in the case of a document/literal wrapped method, the complex aggregate of the non-header input or output parameters.

Each web method consists of a set of web messages.

Author:

Ryan Heaton

Method Summary

java.lang.String	getMessageDocs() The documentation for this web message.
java.lang.String	getMessageName() The name of this web message.
java.util.Collection<WebMessagePart>	getParts() The parts of this complex input/output.
boolean	isFault() Whether this message is a web fault.
boolean	isHeader() Whether this message is a header parameter.
boolean	isInput() Whether this is an input message.
boolean	isOutput() Whether this is an output message.

Method Detail

getMessageName

java.lang.String getMessageName()

The name of this web message.

Returns:

The name of this web message.

getMessageDocs

java.lang.String getMessageDocs()

The documentation for this web message.

Returns:

The documentation for this web message.

isInput

boolean isInput()

Whether this is an input message.

Returns:

Whether this is an input message.

isOutput

boolean isOutput()

Whether this is an output message.

Returns:

Whether this is an output message.

isHeader

boolean isHeader()

Whether this message is a header parameter.

Returns:

Whether this message is a header parameter.

isFault

boolean isFault()

Whether this message is a web fault.

Returns:

Whether this message is a web fault.

getParts

java.util.Collection<WebMessagePart> getParts()

The parts of this complex input/output.

Returns:

The parts of this complex input/output.