OperationDesc (Apache Axis)

java.lang.Object
- org.apache.axis.description.OperationDesc

All Implemented Interfaces:

Serializable
```
public class OperationDesc
extends Object
implements Serializable
```
An OperationDesc is an abstract description of an operation on a service. !!! WORK IN PROGRESS

Author:

Glen Daniels (gdaniels@apache.org)

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`
`static int`	`MSG_METHOD_BODYARRAY`
`static int`	`MSG_METHOD_DOCUMENT`
`static int`	`MSG_METHOD_ELEMENTARRAY`
`static int`	`MSG_METHOD_NONCONFORMING`
`static int`	`MSG_METHOD_SOAPENVELOPE`

Constructor Summary

Constructors
Constructor and Description
`OperationDesc()` Default constructor.
`OperationDesc(String name, ParameterDesc[] parameters, QName returnQName)` "Complete" constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFault(FaultDesc fault)`
`void`	`addParameter(ParameterDesc param)`
`void`	`addParameter(QName paramName, QName xmlType, Class javaType, byte parameterMode, boolean inHeader, boolean outHeader)`
`ArrayList`	`getAllInParams()` Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
`ArrayList`	`getAllOutParams()` Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
`String`	`getDocumentation()` get the documentation for the operation
`QName`	`getElementQName()`
`FaultDesc`	`getFaultByClass(Class cls)` Returns the FaultDesc for the fault class given.
`FaultDesc`	`getFaultByClass(Class cls, boolean checkParents)` Returns the FaultDesc for the fault class given.
`FaultDesc`	`getFaultByQName(QName qname)` Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault).
`FaultDesc`	`getFaultByXmlType(QName xmlType)` Returns the FaultDesc for an XMLType.
`ArrayList`	`getFaults()`
`ParameterDesc`	`getInputParamByQName(QName qname)`
`javax.wsdl.OperationType`	`getMep()`
`String`	`getMepString()` Get the MEP as a string.
`int`	`getMessageOperationStyle()`
`Method`	`getMethod()`
`String`	`getName()` Return the operation's name
`int`	`getNumInParams()`
`int`	`getNumOutParams()`
`int`	`getNumParams()`
`ArrayList`	`getOutParams()` Returns an ordered list of out params (NOT inouts)
`ParameterDesc`	`getOutputParamByQName(QName qname)`
`ParameterDesc`	`getParamByQName(QName qname)`
`ParameterDesc`	`getParameter(int i)`
`ArrayList`	`getParameters()`
`ServiceDesc`	`getParent()`
`Class`	`getReturnClass()`
`ParameterDesc`	`getReturnParamDesc()`
`QName`	`getReturnQName()`
`QName`	`getReturnType()`
`String`	`getSoapAction()`
`Style`	`getStyle()` Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.
`Use`	`getUse()` Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.
`boolean`	`isReturnHeader()` Is the return value in the header of the response message?
`void`	`setDocumentation(String documentation)` set the documentation for the operation
`void`	`setElementQName(QName elementQName)`
`void`	`setMep(javax.wsdl.OperationType mep)`
`void`	`setMep(String mepString)` Set the MEP using a string like "request-response"
`void`	`setMessageOperationStyle(int messageOperationStyle)`
`void`	`setMethod(Method method)`
`void`	`setName(String name)` Set the operation's name
`void`	`setParameters(ArrayList newParameters)` Set the parameters wholesale.
`void`	`setParent(ServiceDesc parent)`
`void`	`setReturnClass(Class returnClass)`
`void`	`setReturnHeader(boolean value)` Set whether the return value is in the response message.
`void`	`setReturnQName(QName returnQName)`
`void`	`setReturnType(QName returnType)`
`void`	`setSoapAction(String soapAction)`
`void`	`setStyle(Style style)`
`void`	`setUse(Use use)`
`String`	`toString()`
`String`	`toString(String indent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MSG_METHOD_BODYARRAY
```
public static final int MSG_METHOD_BODYARRAY
```
See Also:
Constant Field Values

MSG_METHOD_SOAPENVELOPE
```
public static final int MSG_METHOD_SOAPENVELOPE
```
See Also:
Constant Field Values

MSG_METHOD_ELEMENTARRAY
```
public static final int MSG_METHOD_ELEMENTARRAY
```
See Also:
Constant Field Values

MSG_METHOD_DOCUMENT
```
public static final int MSG_METHOD_DOCUMENT
```
See Also:
Constant Field Values

MSG_METHOD_NONCONFORMING
```
public static final int MSG_METHOD_NONCONFORMING
```
See Also:
Constant Field Values

log

protected static org.apache.commons.logging.Log log

Constructor Detail

OperationDesc
```
public OperationDesc()
```
Default constructor.

OperationDesc

public OperationDesc(String name,
             ParameterDesc[] parameters,
             QName returnQName)

"Complete" constructor

Method Detail

getName
```
public String getName()
```
Return the operation's name

setName
```
public void setName(String name)
```
Set the operation's name

getDocumentation
```
public String getDocumentation()
```
get the documentation for the operation

setDocumentation

public void setDocumentation(String documentation)

set the documentation for the operation

getReturnQName
```
public QName getReturnQName()
```

setReturnQName

public void setReturnQName(QName returnQName)

getReturnType
```
public QName getReturnType()
```

setReturnType

public void setReturnType(QName returnType)

getReturnClass
```
public Class getReturnClass()
```

setReturnClass

public void setReturnClass(Class returnClass)

getElementQName
```
public QName getElementQName()
```

setElementQName

public void setElementQName(QName elementQName)

getParent
```
public ServiceDesc getParent()
```

setParent

public void setParent(ServiceDesc parent)

getSoapAction
```
public String getSoapAction()
```

setSoapAction

public void setSoapAction(String soapAction)

setStyle
```
public void setStyle(Style style)
```

getStyle
```
public Style getStyle()
```
Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.

setUse
```
public void setUse(Use use)
```

getUse
```
public Use getUse()
```
Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.

addParameter

public void addParameter(ParameterDesc param)

addParameter

public void addParameter(QName paramName,
                QName xmlType,
                Class javaType,
                byte parameterMode,
                boolean inHeader,
                boolean outHeader)

getParameter

public ParameterDesc getParameter(int i)

getParameters
```
public ArrayList getParameters()
```

setParameters
```
public void setParameters(ArrayList newParameters)
```
Set the parameters wholesale.

Parameters:
newParameters - an ArrayList of ParameterDescs

getNumInParams
```
public int getNumInParams()
```

getNumOutParams
```
public int getNumOutParams()
```

getNumParams
```
public int getNumParams()
```

getMethod
```
public Method getMethod()
```

setMethod
```
public void setMethod(Method method)
```

isReturnHeader
```
public boolean isReturnHeader()
```
Is the return value in the header of the response message?

setReturnHeader
```
public void setReturnHeader(boolean value)
```
Set whether the return value is in the response message.

getParamByQName

public ParameterDesc getParamByQName(QName qname)

getInputParamByQName

public ParameterDesc getInputParamByQName(QName qname)

getOutputParamByQName

public ParameterDesc getOutputParamByQName(QName qname)

getAllInParams
```
public ArrayList getAllInParams()
```
Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.

Returns:

getAllOutParams
```
public ArrayList getAllOutParams()
```
Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.

Returns:

getOutParams
```
public ArrayList getOutParams()
```
Returns an ordered list of out params (NOT inouts)

addFault

public void addFault(FaultDesc fault)

getFaults
```
public ArrayList getFaults()
```

getFaultByClass
```
public FaultDesc getFaultByClass(Class cls)
```
Returns the FaultDesc for the fault class given. Returns null if not found.

getFaultByClass

public FaultDesc getFaultByClass(Class cls,
                        boolean checkParents)

Returns the FaultDesc for the fault class given. Returns null if not found.

getFaultByQName
```
public FaultDesc getFaultByQName(QName qname)
```
Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault). Returns null if not found.

getFaultByXmlType
```
public FaultDesc getFaultByXmlType(QName xmlType)
```
Returns the FaultDesc for an XMLType. Returns null if not found.

getReturnParamDesc

public ParameterDesc getReturnParamDesc()

toString
```
public String toString()
```
Overrides:

toString in class Object

toString

public String toString(String indent)

getMessageOperationStyle
```
public int getMessageOperationStyle()
```

setMessageOperationStyle

public void setMessageOperationStyle(int messageOperationStyle)

getMep

public javax.wsdl.OperationType getMep()

setMep

public void setMep(javax.wsdl.OperationType mep)

getMepString
```
public String getMepString()
```
Get the MEP as a string.

Returns:
the string representation of the MEP

setMep
```
public void setMep(String mepString)
```
Set the MEP using a string like "request-response"

Parameters:
mepString -

Class OperationDesc

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MSG_METHOD_BODYARRAY

MSG_METHOD_SOAPENVELOPE

MSG_METHOD_ELEMENTARRAY

MSG_METHOD_DOCUMENT

MSG_METHOD_NONCONFORMING

log

Constructor Detail

OperationDesc

OperationDesc

Method Detail

getName

setName

getDocumentation

setDocumentation

getReturnQName

setReturnQName

getReturnType

setReturnType

getReturnClass

setReturnClass

getElementQName

setElementQName

getParent

setParent

getSoapAction

setSoapAction

setStyle

getStyle

setUse

getUse

addParameter

addParameter

getParameter

getParameters

setParameters

getNumInParams

getNumOutParams

getNumParams

getMethod

setMethod

isReturnHeader

setReturnHeader

getParamByQName

getInputParamByQName

getOutputParamByQName

getAllInParams

getAllOutParams

getOutParams

addFault

getFaults

getFaultByClass

getFaultByClass

getFaultByQName

getFaultByXmlType

getReturnParamDesc

toString

toString

getMessageOperationStyle

setMessageOperationStyle

getMep

setMep

getMepString

setMep