com.ibm.wsdl

Class OperationImpl

Implemented Interfaces:
ElementExtensible, Operation, java.io.Serializable

public class OperationImpl
extends java.lang.Object
implements Operation

This class represents a WSDL operation. It includes information on input, output and fault messages associated with usage of the operation.
Authors:
Paul Fremantle (pzf@us.ibm.com)
Nirmal Mukhi (nmukhi@us.ibm.com)
Matthew J. Duftler (duftler@us.ibm.com)

Field Summary

protected Element
docEl
protected List
extElements
protected Map
faults
protected Input
input
protected boolean
isUndefined
protected String
name
protected Output
output
protected List
parameterOrder
static long
serialVersionUID
protected OperationType
style

Method Summary

void
addExtensibilityElement(ExtensibilityElement extElement)
Add an extensibility element.
void
addFault(Fault fault)
Add a fault message that must be associated with this operation.
Element
getDocumentationElement()
Get the documentation element.
List
getExtensibilityElements()
Get all the extensibility elements defined here.
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)
String
toString()

Field Details

docEl

protected Element docEl

extElements

protected List extElements

faults

protected Map faults

input

protected Input input

isUndefined

protected boolean isUndefined

name

protected String name

output

protected Output output

parameterOrder

protected List parameterOrder

serialVersionUID

public static final long serialVersionUID
Field Value:
1L

style

protected OperationType style

Method Details

addExtensibilityElement

public void addExtensibilityElement(ExtensibilityElement extElement)
Add an extensibility element.
Specified by:
addExtensibilityElement in interface ElementExtensible
Parameters:
extElement - the extensibility element to be added

addFault

public void addFault(Fault fault)
Add a fault message that must be associated with this operation.
Specified by:
addFault in interface 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.
Specified by:
getDocumentationElement in interface Operation
Returns:
the documentation element

getExtensibilityElements

public List getExtensibilityElements()
Get all the extensibility elements defined here.
Specified by:
getExtensibilityElements in interface ElementExtensible

getFault

public Fault getFault(String name)
Get the specified fault message.
Specified by:
getFault in interface Operation
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.
Specified by:
getFaults in interface Operation
Returns:
names of fault messages

getInput

public Input getInput()
Get the input message specification for this operation.
Specified by:
getInput in interface Operation
Returns:
the input message

getName

public String getName()
Get the name of this operation.
Specified by:
getName in interface Operation
Returns:
the operation name

getOutput

public Output getOutput()
Get the output message specification for this operation.
Specified by:
getOutput in interface Operation
Returns:
the output message specification for the operation

getParameterOrdering

public List getParameterOrdering()
Get the parameter ordering for this operation.
Specified by:
getParameterOrdering in interface Operation
Returns:
the parameter ordering, a list consisting of message part names

getStyle

public OperationType getStyle()
Get the operation type.
Specified by:
getStyle in interface Operation
Returns:
the operation type

isUndefined

public boolean isUndefined()
Specified by:
isUndefined in interface Operation

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.
Specified by:
setDocumentationElement in interface Operation
Parameters:
docEl - the documentation element

setInput

public void setInput(Input input)
Set the input message specification for this operation.
Specified by:
setInput in interface Operation
Parameters:
input - the new input message

setName

public void setName(String name)
Set the name of this operation.
Specified by:
setName in interface Operation
Parameters:
name - the desired name

setOutput

public void setOutput(Output output)
Set the output message specification for this operation.
Specified by:
setOutput in interface Operation
Parameters:
output - the new output message

setParameterOrdering

public void setParameterOrdering(List parameterOrder)
Set the parameter ordering for a request-response, or solicit-response operation.
Specified by:
setParameterOrdering in interface Operation
Parameters:

setStyle

public void setStyle(OperationType style)
Set the style for this operation (request-response, one way, solicit-response or notification).
Specified by:
setStyle in interface Operation
Parameters:
style - the new operation style

setUndefined

public void setUndefined(boolean isUndefined)
Specified by:
setUndefined in interface Operation

toString

public String toString()