javax.wsdl

Interface Operation

public interface Operation extends Serializable, ElementExtensible

This interface represents a WSDL operation. It includes information on input, output and fault messages associated with usage of the operation.

Author: Paul Fremantle (pzf@us.ibm.com) Nirmal Mukhi (nmukhi@us.ibm.com) Matthew J. Duftler (duftler@us.ibm.com)

Method Summary
void	addFault(Fault fault) Add a fault message that must be associated with this operation.
Element	getDocumentationElement() Get the documentation element.
Fault	getFault(String name) Get the specified fault message.
Map	getFaults() Get all the fault messages associated with this operation.
Input	getInput() Get the input message specification for this operation.
String	getName() Get the name of this operation.
Output	getOutput() Get the output message specification for this operation.
List	getParameterOrdering() Get the parameter ordering for this operation.
OperationType	getStyle() Get the operation type.
boolean	isUndefined()
void	setDocumentationElement(Element docEl) Set the documentation element for this document.
void	setInput(Input input) Set the input message specification for this operation.
void	setName(String name) Set the name of this operation.
void	setOutput(Output output) Set the output message specification for this operation.
void	setParameterOrdering(List parameterOrder) Set the parameter ordering for a request-response, or solicit-response operation.
void	setStyle(OperationType style) Set the style for this operation (request-response, one way, solicit-response or notification).
void	setUndefined(boolean isUndefined)

Method Detail

addFault

public void addFault(Fault fault)

Add a fault message that must be associated with this operation.

Parameters: fault the new fault message

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

getFault

public Fault getFault(String name)

Get the specified fault message.

Parameters: name the name of the desired fault message.

Returns: the corresponding fault message, or null if there wasn't any matching message

getFaults

public Map getFaults()

Get all the fault messages associated with this operation.

Returns: names of fault messages

getInput

public Input getInput()

Get the input message specification for this operation.

Returns: the input message

getName

public String getName()

Get the name of this operation.

Returns: the operation name

getOutput

public Output getOutput()

Get the output message specification for this operation.

Returns: the output message specification for the operation

getParameterOrdering

public List getParameterOrdering()

Get the parameter ordering for this operation.

Returns: the parameter ordering, a list consisting of message part names

getStyle

public OperationType getStyle()

Get the operation type.

Returns: the operation type

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