Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis.description
Class OperationDesc

java.lang.Object
  extended byorg.jboss.axis.description.OperationDesc
public class OperationDesc
extends java.lang.Object

An OperationDesc is an abstract description of an operation on a service.

Field Summary
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
OperationDesc()
          Default constructor.
OperationDesc(java.lang.String name, ParameterDesc (src) [] parameters, QName (src)  returnQName)
          "Complete" constructor
 
Method Summary
 void addFault(FaultDesc (src)  fault)
           
 void addParameter(ParameterDesc (src)  param)
           
 void addParameter(QName (src)  paramName, QName (src)  xmlType, java.lang.Class javaType, byte parameterMode, boolean inHeader, boolean outHeader)
           
 java.util.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.
 java.util.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.
 QName (src) getElementQName()
           
 FaultDesc (src) getFaultByClass(java.lang.Class cls)
          Returns the FaultDesc for the fault class given.
 FaultDesc (src) getFaultByQName(QName (src)  qname)
          Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault).
 FaultDesc (src) getFaultByXmlType(QName (src)  xmlType)
          Returns the FaultDesc for an XMLType.
 java.util.ArrayList getFaults()
           
 java.util.ArrayList getInParams()
          Returns an ordered list of IN params (not INOUT)
 ParameterDesc (src) getInputParamByQName(QName (src)  qname)
           
 int getMessageOperationStyle()
           
 java.lang.reflect.Method getMethod()
           
 java.lang.String getName()
          Return the operation's name
 int getNumInParams()
           
 int getNumOutParams()
           
 int getNumParams()
           
 java.util.ArrayList getOutParams()
          Returns an ordered list of OUT params (not INOUT)
 ParameterDesc (src) getOutputParamByQName(QName (src)  qname)
           
 ParameterDesc (src) getParamByQName(QName (src)  qname)
           
 ParameterDesc (src) getParameter(int i)
           
 java.util.ArrayList getParameters()
           
 ServiceDesc (src) getParent()
           
 java.lang.Class getReturnClass()
           
 ParameterDesc (src) getReturnParamDesc()
           
 QName (src) getReturnQName()
           
 QName (src) getReturnType()
           
 java.lang.String getSoapAction()
           
 Style (src) getStyle()
          Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.
 Use (src) getUse()
          Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.
 boolean isOneWay()
           
 boolean isReturnHeader()
          Is the return value in the header of the response message?
 void setElementQName(QName (src)  elementQName)
           
 void setMessageOperationStyle(int messageOperationStyle)
           
 void setMethod(java.lang.reflect.Method method)
           
 void setName(java.lang.String name)
          Set the operation's name
 void setOneWay(boolean oneWay)
           
 void setParameters(java.util.ArrayList newParameters)
          Set the parameters wholesale.
 void setParent(ServiceDesc (src)  parent)
           
 void setReturnClass(java.lang.Class returnClass)
           
 void setReturnHeader(boolean value)
          Set whether the return value is in the response message.
 void setReturnQName(QName (src)  returnQName)
           
 void setReturnType(QName (src)  returnType)
           
 void setSoapAction(java.lang.String soapAction)
           
 void setStyle(Style (src)  style)
           
 void setUse(Use (src)  use)
           
 java.lang.String toString()
           
 java.lang.String toString(java.lang.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 (src)

MSG_METHOD_SOAPENVELOPE

public static final int MSG_METHOD_SOAPENVELOPE
See Also:
Constant Field Values (src)

MSG_METHOD_ELEMENTARRAY

public static final int MSG_METHOD_ELEMENTARRAY
See Also:
Constant Field Values (src)

MSG_METHOD_DOCUMENT

public static final int MSG_METHOD_DOCUMENT
See Also:
Constant Field Values (src)

MSG_METHOD_NONCONFORMING

public static final int MSG_METHOD_NONCONFORMING
See Also:
Constant Field Values (src)
Constructor Detail

OperationDesc

public OperationDesc()
Default constructor.

OperationDesc

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

Method Detail

getName

public java.lang.String getName()
Return the operation's name

setName

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

getReturnQName

public QName (src)  getReturnQName()

setReturnQName

public void setReturnQName(QName (src)  returnQName)

getReturnType

public QName (src)  getReturnType()

setReturnType

public void setReturnType(QName (src)  returnType)

getReturnClass

public java.lang.Class getReturnClass()

setReturnClass

public void setReturnClass(java.lang.Class returnClass)

getElementQName

public QName (src)  getElementQName()

setElementQName

public void setElementQName(QName (src)  elementQName)

isOneWay

public boolean isOneWay()

setOneWay

public void setOneWay(boolean oneWay)

getParent

public ServiceDesc (src)  getParent()

setParent

public void setParent(ServiceDesc (src)  parent)

getSoapAction

public java.lang.String getSoapAction()

setSoapAction

public void setSoapAction(java.lang.String soapAction)

setStyle

public void setStyle(Style (src)  style)

getStyle

public Style (src)  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 (src)  use)

getUse

public Use (src)  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 (src)  param)

addParameter

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

getParameter

public ParameterDesc (src)  getParameter(int i)

getParameters

public java.util.ArrayList getParameters()

setParameters

public void setParameters(java.util.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 java.lang.reflect.Method getMethod()

setMethod

public void setMethod(java.lang.reflect.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 (src)  getParamByQName(QName (src)  qname)

getInputParamByQName

public ParameterDesc (src)  getInputParamByQName(QName (src)  qname)

getOutputParamByQName

public ParameterDesc (src)  getOutputParamByQName(QName (src)  qname)

getAllInParams

public java.util.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 java.util.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:

getInParams

public java.util.ArrayList getInParams()
Returns an ordered list of IN params (not INOUT)

getOutParams

public java.util.ArrayList getOutParams()
Returns an ordered list of OUT params (not INOUT)

addFault

public void addFault(FaultDesc (src)  fault)

getFaults

public java.util.ArrayList getFaults()

getFaultByClass

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

getFaultByQName

public FaultDesc (src)  getFaultByQName(QName (src)  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 (src)  getFaultByXmlType(QName (src)  xmlType)
Returns the FaultDesc for an XMLType. Returns null if not found.

getReturnParamDesc

public ParameterDesc (src)  getReturnParamDesc()

toString

public java.lang.String toString()

toString

public java.lang.String toString(java.lang.String indent)

getMessageOperationStyle

public int getMessageOperationStyle()

setMessageOperationStyle

public void setMessageOperationStyle(int messageOperationStyle)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD