com.ebmwebsourcing.commons.wsdl.api
Interface Operation

All Superinterfaces:

java.io.Serializable, WSDLElement

All Known Implementing Classes:

AbstractOperationImpl, OperationImpl, OperationImpl

public interface Operation
extends WSDLElement

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

Author:

Nicolas Salatge - eBM WebSourcing

Method Summary

void	addFault(Fault fault) Add a fault message that must be associated with this operation.
Fault	getFault(java.lang.String name) Get the specified fault .
Fault	getFaultByElementName(javax.xml.namespace.QName name) Get the specified fault .
java.util.List<Fault>	getFaults() Get all the fault messages associated with this operation.
Input	getInput() Get the input message specification for this operation.
Output	getOutput() Get the output message specification for this operation.
java.util.List<java.lang.String>	getParameterOrdering() Get the parameter ordering for this operation.
Constants.MEPPatternConstants	getPattern() get the pattern
javax.xml.namespace.QName	getQName() Get the name of this operation.
java.lang.String	getSignature() get signature of the operation
Fault	removeFault(java.lang.String name) Remove the specified fault message.
Fault	removeFaultByElementName(javax.xml.namespace.QName name) Remove the specified fault .
void	setInput(Input input) Set the input message specification for this operation.
void	setOutput(Output output) Set the output message specification for this operation.
void	setParameterOrdering(java.util.List<java.lang.String> parameterOrder) Set the parameter ordering for a request-response, or solicit-response operation.
void	setPattern(Constants.MEPPatternConstants pattern) set the pattern
void	setQName(javax.xml.namespace.QName name) Set the name of this operation.

Methods inherited from interface com.ebmwebsourcing.commons.wsdl.api.WSDLElement

createDocumentation, getDocumentation, getOtherAttributes, getOtherElements, setDocumentation

Method Detail

setQName

void setQName(javax.xml.namespace.QName name)

Set the name of this operation.

Parameters:

name - the desired name

getQName

javax.xml.namespace.QName getQName()

Get the name of this operation.

Returns:

the operation name

setInput

void setInput(Input input)

Set the input message specification for this operation.

Parameters:

input - the new input message

getInput

Input getInput()

Get the input message specification for this operation.

Returns:

the input message

setOutput

void setOutput(Output output)

Set the output message specification for this operation.

Parameters:

output - the new output message

getOutput

Output getOutput()

Get the output message specification for this operation.

Returns:

the output message specification for the operation

addFault

void addFault(Fault fault)

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

Parameters:

fault - the new fault message

getFault

Fault getFault(java.lang.String name)

Get the specified fault .

Parameters:

name - the name of the desired fault message.

Returns:

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

getFaultByElementName

Fault getFaultByElementName(javax.xml.namespace.QName name)

Get the specified fault .

Parameters:

name - the name of the fault element.

Returns:

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

removeFault

Fault removeFault(java.lang.String name)

Remove the specified fault message.

Parameters:

name - the name of the fault message to be removed.

Returns:

the fault message which was removed

removeFaultByElementName

Fault removeFaultByElementName(javax.xml.namespace.QName name)

Remove the specified fault .

Parameters:

name - the name of the fault element to be removed.

Returns:

the fault message which was removed

getFaults

java.util.List<Fault> getFaults()

Get all the fault messages associated with this operation.

Returns:

names of fault messages

setParameterOrdering

void setParameterOrdering(java.util.List<java.lang.String> parameterOrder)
                          throws WSDLException

Set the parameter ordering for a request-response, or solicit-response operation.

Parameters:

parameterOrder - a list of named parameters containing the part names to reflect the desired order of parameters for RPC-style operations

Throws:

WSDLException

getParameterOrdering

java.util.List<java.lang.String> getParameterOrdering()

Get the parameter ordering for this operation.

Returns:

the parameter ordering, a list consisting of message part names

getPattern

Constants.MEPPatternConstants getPattern()

get the pattern

setPattern

void setPattern(Constants.MEPPatternConstants pattern)
                throws WSDLException

set the pattern

Parameters:

pattern - the pattern

Throws:

WSDLException

getSignature

java.lang.String getSignature()

get signature of the operation

Returns:

the signature