org.apache.axis.description

Class OperationDesc

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)

Field Summary
protected static Loglog
static MapmepStrings
static intMSG_METHOD_BODYARRAY
static intMSG_METHOD_DOCUMENT
static intMSG_METHOD_ELEMENTARRAY
static intMSG_METHOD_NONCONFORMING
static intMSG_METHOD_SOAPENVELOPE
Constructor Summary
OperationDesc()
Default constructor.
OperationDesc(String name, ParameterDesc[] parameters, QName returnQName)
"Complete" constructor
Method Summary
voidaddFault(FaultDesc fault)
voidaddParameter(ParameterDesc param)
voidaddParameter(QName paramName, QName xmlType, Class javaType, byte parameterMode, boolean inHeader, boolean outHeader)
ArrayListgetAllInParams()
Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
ArrayListgetAllOutParams()
Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
StringgetDocumentation()
get the documentation for the operation
QNamegetElementQName()
FaultDescgetFaultByClass(Class cls)
Returns the FaultDesc for the fault class given.
FaultDescgetFaultByClass(Class cls, boolean checkParents)
Returns the FaultDesc for the fault class given.
FaultDescgetFaultByQName(QName qname)
Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault).
FaultDescgetFaultByXmlType(QName xmlType)
Returns the FaultDesc for an XMLType.
ArrayListgetFaults()
ParameterDescgetInputParamByQName(QName qname)
OperationTypegetMep()
intgetMessageOperationStyle()
MethodgetMethod()
StringgetName()
Return the operation's name
intgetNumInParams()
intgetNumOutParams()
intgetNumParams()
ParameterDescgetOutputParamByQName(QName qname)
ArrayListgetOutParams()
Returns an ordered list of out params (NOT inouts)
ParameterDescgetParamByQName(QName qname)
ParameterDescgetParameter(int i)
ArrayListgetParameters()
ServiceDescgetParent()
ClassgetReturnClass()
ParameterDescgetReturnParamDesc()
QNamegetReturnQName()
QNamegetReturnType()
StringgetSoapAction()
StylegetStyle()
Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.
UsegetUse()
Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.
booleanisReturnHeader()
Is the return value in the header of the response message?
voidsetDocumentation(String documentation)
set the documentation for the operation
voidsetElementQName(QName elementQName)
voidsetMep(OperationType mep)
voidsetMep(String mepString)
Set the MEP using a string like "request-response"
voidsetMessageOperationStyle(int messageOperationStyle)
voidsetMethod(Method method)
voidsetName(String name)
Set the operation's name
voidsetParameters(ArrayList newParameters)
Set the parameters wholesale.
voidsetParent(ServiceDesc parent)
voidsetReturnClass(Class returnClass)
voidsetReturnHeader(boolean value)
Set whether the return value is in the response message.
voidsetReturnQName(QName returnQName)
voidsetReturnType(QName returnType)
voidsetSoapAction(String soapAction)
voidsetStyle(Style style)
voidsetUse(Use use)
StringtoString()
StringtoString(String indent)

Field Detail

log

protected static Log log

mepStrings

public static Map mepStrings

MSG_METHOD_BODYARRAY

public static final int MSG_METHOD_BODYARRAY

MSG_METHOD_DOCUMENT

public static final int MSG_METHOD_DOCUMENT

MSG_METHOD_ELEMENTARRAY

public static final int MSG_METHOD_ELEMENTARRAY

MSG_METHOD_NONCONFORMING

public static final int MSG_METHOD_NONCONFORMING

MSG_METHOD_SOAPENVELOPE

public static final int MSG_METHOD_SOAPENVELOPE

Constructor Detail

OperationDesc

public OperationDesc()
Default constructor.

OperationDesc

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

Method Detail

addFault

public void addFault(FaultDesc fault)

addParameter

public void addParameter(ParameterDesc param)

addParameter

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

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:

getDocumentation

public String getDocumentation()
get the documentation for the operation

getElementQName

public QName getElementQName()

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.

getFaults

public ArrayList getFaults()

getInputParamByQName

public ParameterDesc getInputParamByQName(QName qname)

getMep

public OperationType getMep()

getMessageOperationStyle

public int getMessageOperationStyle()

getMethod

public Method getMethod()

getName

public String getName()
Return the operation's name

getNumInParams

public int getNumInParams()

getNumOutParams

public int getNumOutParams()

getNumParams

public int getNumParams()

getOutputParamByQName

public ParameterDesc getOutputParamByQName(QName qname)

getOutParams

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

getParamByQName

public ParameterDesc getParamByQName(QName qname)

getParameter

public ParameterDesc getParameter(int i)

getParameters

public ArrayList getParameters()

getParent

public ServiceDesc getParent()

getReturnClass

public Class getReturnClass()

getReturnParamDesc

public ParameterDesc getReturnParamDesc()

getReturnQName

public QName getReturnQName()

getReturnType

public QName getReturnType()

getSoapAction

public String getSoapAction()

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.

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.

isReturnHeader

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

setDocumentation

public void setDocumentation(String documentation)
set the documentation for the operation

setElementQName

public void setElementQName(QName elementQName)

setMep

public void setMep(OperationType mep)

setMep

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

Parameters: mepString

setMessageOperationStyle

public void setMessageOperationStyle(int messageOperationStyle)

setMethod

public void setMethod(Method method)

setName

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

setParameters

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

Parameters: newParameters an ArrayList of ParameterDescs

setParent

public void setParent(ServiceDesc parent)

setReturnClass

public void setReturnClass(Class returnClass)

setReturnHeader

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

setReturnQName

public void setReturnQName(QName returnQName)

setReturnType

public void setReturnType(QName returnType)

setSoapAction

public void setSoapAction(String soapAction)

setStyle

public void setStyle(Style style)

setUse

public void setUse(Use use)

toString

public String toString()

toString

public String toString(String indent)
Copyright B) 2005 Apache Web Services Project. All Rights Reserved.