Package javax.wsdl
Interface Operation
-
- All Superinterfaces:
AttributeExtensible,ElementExtensible,java.io.Serializable,WSDLElement
- All Known Implementing Classes:
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:
- 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddFault(Fault fault)Add a fault message that must be associated with this operation.FaultgetFault(java.lang.String name)Get the specified fault message.java.util.MapgetFaults()Get all the fault messages associated with this operation.InputgetInput()Get the input message specification for this operation.java.lang.StringgetName()Get the name of this operation.OutputgetOutput()Get the output message specification for this operation.java.util.ListgetParameterOrdering()Get the parameter ordering for this operation.OperationTypegetStyle()Get the operation type.booleanisUndefined()FaultremoveFault(java.lang.String name)Remove the specified fault message.voidsetInput(Input input)Set the input message specification for this operation.voidsetName(java.lang.String name)Set the name of this operation.voidsetOutput(Output output)Set the output message specification for this operation.voidsetParameterOrdering(java.util.List parameterOrder)Set the parameter ordering for a request-response, or solicit-response operation.voidsetStyle(OperationType style)Set the style for this operation (request-response, one way, solicit-response or notification).voidsetUndefined(boolean isUndefined)-
Methods inherited from interface javax.wsdl.extensions.AttributeExtensible
getExtensionAttribute, getExtensionAttributes, getNativeAttributeNames, setExtensionAttribute
-
Methods inherited from interface javax.wsdl.extensions.ElementExtensible
addExtensibilityElement, getExtensibilityElements, removeExtensibilityElement
-
Methods inherited from interface javax.wsdl.WSDLElement
getDocumentationElement, setDocumentationElement
-
-
-
-
Method Detail
-
setName
void setName(java.lang.String name)
Set the name of this operation.- Parameters:
name- the desired name
-
getName
java.lang.String getName()
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 message.- Parameters:
name- the name of the desired fault message.- 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
-
getFaults
java.util.Map getFaults()
Get all the fault messages associated with this operation.- Returns:
- names of fault messages
-
setStyle
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
OperationType getStyle()
Get the operation type.- Returns:
- the operation type
-
setParameterOrdering
void setParameterOrdering(java.util.List parameterOrder)
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
-
getParameterOrdering
java.util.List getParameterOrdering()
Get the parameter ordering for this operation.- Returns:
- the parameter ordering, a list consisting of message part names
-
setUndefined
void setUndefined(boolean isUndefined)
-
isUndefined
boolean isUndefined()
-
-