Package org.apache.axis.description

Class OperationDesc

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:

  • Field Details

    • MSG_METHOD_BODYARRAY

      public static final int MSG_METHOD_BODYARRAY
      See Also:

    • MSG_METHOD_SOAPENVELOPE

      public static final int MSG_METHOD_SOAPENVELOPE
      See Also:

    • MSG_METHOD_ELEMENTARRAY

      public static final int MSG_METHOD_ELEMENTARRAY
      See Also:

    • MSG_METHOD_DOCUMENT

      public static final int MSG_METHOD_DOCUMENT
      See Also:

    • MSG_METHOD_NONCONFORMING

      public static final int MSG_METHOD_NONCONFORMING
      See Also:

    • mepStrings

      public static Map mepStrings

    • log

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

  • Constructor Details

    • OperationDesc

      public OperationDesc()
      Default constructor.

    • OperationDesc

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

  • Method Details

    • 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)

    • setMep

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