站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBoss 3.2.7 jaxrpc API Documentation 英文版文档

OperationDesc (JAXRPC API) - JBoss 3.2.7 jaxrpc API Documentation 英文版文档

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

org.apache.axis.description
Class OperationDesc

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

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

Author:
Glen Daniels (gdaniels@apache.org)

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(String name, ParameterDesc[] parameters, javax.xml.namespace.QName returnQName)
          "Complete" constructor
 
Method Summary
 void addFault(FaultDesc fault)
           
 void addParameter(ParameterDesc param)
           
 void addParameter(javax.xml.namespace.QName paramName, javax.xml.namespace.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.
 javax.xml.namespace.QName getElementQName()
           
 FaultDesc getFaultByClass(Class cls)
          Returns the FaultDesc for the fault class given.
 FaultDesc getFaultByQName(javax.xml.namespace.QName qname)
          Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault).
 FaultDesc getFaultByXmlType(javax.xml.namespace.QName xmlType)
          Returns the FaultDesc for an XMLType.
 ArrayList getFaults()
           
 ArrayList getInParams()
          Returns an ordered list of IN params (not INOUT)
 ParameterDesc getInputParamByQName(javax.xml.namespace.QName qname)
           
 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 INOUT)
 ParameterDesc getOutputParamByQName(javax.xml.namespace.QName qname)
           
 ParameterDesc getParamByQName(javax.xml.namespace.QName qname)
           
 ParameterDesc getParameter(int i)
           
 ArrayList getParameters()
           
 ServiceDesc getParent()
           
 Class getReturnClass()
           
 ParameterDesc getReturnParamDesc()
           
 javax.xml.namespace.QName getReturnQName()
           
 javax.xml.namespace.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 isOneWay()
           
 boolean isReturnHeader()
          Is the return value in the header of the response message?
 void setElementQName(javax.xml.namespace.QName elementQName)
           
 void setMessageOperationStyle(int messageOperationStyle)
           
 void setMethod(Method method)
           
 void setName(String name)
          Set the operation's name
 void setOneWay(boolean oneWay)
           
 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(javax.xml.namespace.QName returnQName)
           
 void setReturnType(javax.xml.namespace.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
Constructor Detail

OperationDesc

public OperationDesc()
Default constructor.

OperationDesc

public OperationDesc(String name,
                     ParameterDesc[] parameters,
                     javax.xml.namespace.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

getReturnQName

public javax.xml.namespace.QName getReturnQName()

setReturnQName

public void setReturnQName(javax.xml.namespace.QName returnQName)

getReturnType

public javax.xml.namespace.QName getReturnType()

setReturnType

public void setReturnType(javax.xml.namespace.QName returnType)

getReturnClass

public Class getReturnClass()

setReturnClass

public void setReturnClass(Class returnClass)

getElementQName

public javax.xml.namespace.QName getElementQName()

setElementQName

public void setElementQName(javax.xml.namespace.QName elementQName)

isOneWay

public boolean isOneWay()

setOneWay

public void setOneWay(boolean oneWay)

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(javax.xml.namespace.QName paramName,
                         javax.xml.namespace.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(javax.xml.namespace.QName qname)

getInputParamByQName

public ParameterDesc getInputParamByQName(javax.xml.namespace.QName qname)

getOutputParamByQName

public ParameterDesc getOutputParamByQName(javax.xml.namespace.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:

getInParams

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

getOutParams

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

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.

getFaultByQName

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

getReturnParamDesc

public ParameterDesc getReturnParamDesc()

toString

public String toString()

toString

public String toString(String indent)

getMessageOperationStyle

public int getMessageOperationStyle()

setMessageOperationStyle

public void setMessageOperationStyle(int messageOperationStyle)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002 JBoss Group, LLC. All Rights Reserved.