javax.wsdl
Interface Operation

All Superinterfaces:
AttributeExtensible, java.io.Serializable
All Known Implementing Classes:
OperationImpl

public interface Operation
extends java.io.Serializable, AttributeExtensible

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)

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
 void addFault(Fault fault)
          Add a fault message that must be associated with this operation.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 Fault getFault(java.lang.String name)
          Get the specified fault message.
 java.util.Map getFaults()
          Get all the fault messages associated with this operation.
 Input getInput()
          Get the input message specification for this operation.
 java.lang.String getName()
          Get the name of this operation.
 Output getOutput()
          Get the output message specification for this operation.
 java.util.List getParameterOrdering()
          Get the parameter ordering for this operation.
 OperationType getStyle()
          Get the operation type.
 boolean isUndefined()
           
 void setDocumentationElement(org.w3c.dom.Element docEl)
          Set the documentation element for this document.
 void setInput(Input input)
          Set the input message specification for this operation.
 void setName(java.lang.String name)
          Set the name of this operation.
 void setOutput(Output output)
          Set the output message specification for this operation.
 void setParameterOrdering(java.util.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)
           
 
Methods inherited from interface javax.wsdl.extensions.AttributeExtensible
getExtensionAttribute, getExtensionAttributes, getNativeAttributeNames, setExtensionAttribute
 

Method Detail

setName

public void setName(java.lang.String name)
Set the name of this operation.

Parameters:
name - the desired name

getName

public java.lang.String getName()
Get the name of this operation.

Returns:
the operation name

setInput

public void setInput(Input input)
Set the input message specification for this operation.

Parameters:
input - the new input message

getInput

public Input getInput()
Get the input message specification for this operation.

Returns:
the input message

setOutput

public void setOutput(Output output)
Set the output message specification for this operation.

Parameters:
output - the new output message

getOutput

public Output getOutput()
Get the output message specification for this operation.

Returns:
the output message specification for the operation

addFault

public void addFault(Fault fault)
Add a fault message that must be associated with this operation.

Parameters:
fault - the new fault message

getFault

public Fault getFault(java.lang.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 java.util.Map getFaults()
Get all the fault messages associated with this operation.

Returns:
names of fault messages

setStyle

public void setStyle(OperationType style)
Set the style for this operation (request-response, one way, solicit-response or notification).

Parameters:
style - the new operation style

getStyle

public OperationType getStyle()
Get the operation type.

Returns:
the operation type

setParameterOrdering

public void setParameterOrdering(java.util.List parameterOrder)
Set the parameter ordering for a request-response, or solicit-response operation.


getParameterOrdering

public java.util.List getParameterOrdering()
Get the parameter ordering for this operation.

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

setDocumentationElement

public void setDocumentationElement(org.w3c.dom.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

getDocumentationElement

public org.w3c.dom.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

setUndefined

public void setUndefined(boolean isUndefined)

isUndefined

public boolean isUndefined()


Copyright ? 2003 IBM. All Rights Reserved.