|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.axis.description.OperationDesc
An OperationDesc is an abstract description of an operation on a service. !!! WORK IN PROGRESS
Field Summary | |
static java.util.Map |
mepStrings
|
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[] parameters,
QName returnQName)
"Complete" constructor |
Method Summary | |
void |
addFault(FaultDesc fault)
|
void |
addParameter(ParameterDesc param)
|
void |
addParameter(QName paramName,
QName 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. |
java.lang.String |
getDocumentation()
get the documentation for the operation |
QName |
getElementQName()
|
FaultDesc |
getFaultByClass(java.lang.Class cls)
Returns the FaultDesc for the fault class given. |
FaultDesc |
getFaultByClass(java.lang.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. |
java.util.ArrayList |
getFaults()
|
ParameterDesc |
getInputParamByQName(QName qname)
|
javax.wsdl.OperationType |
getMep()
|
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 inouts) |
ParameterDesc |
getOutputParamByQName(QName qname)
|
ParameterDesc |
getParamByQName(QName qname)
|
ParameterDesc |
getParameter(int i)
|
java.util.ArrayList |
getParameters()
|
ServiceDesc |
getParent()
|
java.lang.Class |
getReturnClass()
|
ParameterDesc |
getReturnParamDesc()
|
QName |
getReturnQName()
|
QName |
getReturnType()
|
java.lang.String |
getSoapAction()
|
org.apache.axis.constants.Style |
getStyle()
Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set. |
org.apache.axis.constants.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(java.lang.String documentation)
set the documentation for the operation |
void |
setElementQName(QName elementQName)
|
void |
setMep(javax.wsdl.OperationType mep)
|
void |
setMep(java.lang.String mepString)
Set the MEP using a string like "request-response" |
void |
setMessageOperationStyle(int messageOperationStyle)
|
void |
setMethod(java.lang.reflect.Method method)
|
void |
setName(java.lang.String name)
Set the operation's name |
void |
setParameters(java.util.ArrayList newParameters)
Set the parameters wholesale. |
void |
setParent(ServiceDesc parent)
|
void |
setReturnClass(java.lang.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(java.lang.String soapAction)
|
void |
setStyle(org.apache.axis.constants.Style style)
|
void |
setUse(org.apache.axis.constants.Use use)
|
java.lang.String |
toString()
|
java.lang.String |
toString(java.lang.String indent)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int MSG_METHOD_BODYARRAY
public static final int MSG_METHOD_SOAPENVELOPE
public static final int MSG_METHOD_ELEMENTARRAY
public static final int MSG_METHOD_DOCUMENT
public static final int MSG_METHOD_NONCONFORMING
public static java.util.Map mepStrings
Constructor Detail |
public OperationDesc()
public OperationDesc(java.lang.String name, ParameterDesc[] parameters, QName returnQName)
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getDocumentation()
public void setDocumentation(java.lang.String documentation)
public QName getReturnQName()
public void setReturnQName(QName returnQName)
public QName getReturnType()
public void setReturnType(QName returnType)
public java.lang.Class getReturnClass()
public void setReturnClass(java.lang.Class returnClass)
public QName getElementQName()
public void setElementQName(QName elementQName)
public ServiceDesc getParent()
public void setParent(ServiceDesc parent)
public java.lang.String getSoapAction()
public void setSoapAction(java.lang.String soapAction)
public void setStyle(org.apache.axis.constants.Style style)
public org.apache.axis.constants.Style getStyle()
public void setUse(org.apache.axis.constants.Use use)
public org.apache.axis.constants.Use getUse()
public void addParameter(ParameterDesc param)
public void addParameter(QName paramName, QName xmlType, java.lang.Class javaType, byte parameterMode, boolean inHeader, boolean outHeader)
public ParameterDesc getParameter(int i)
public java.util.ArrayList getParameters()
public void setParameters(java.util.ArrayList newParameters)
newParameters
- an ArrayList of ParameterDescspublic int getNumInParams()
public int getNumOutParams()
public int getNumParams()
public java.lang.reflect.Method getMethod()
public void setMethod(java.lang.reflect.Method method)
public boolean isReturnHeader()
public void setReturnHeader(boolean value)
public ParameterDesc getParamByQName(QName qname)
public ParameterDesc getInputParamByQName(QName qname)
public ParameterDesc getOutputParamByQName(QName qname)
public java.util.ArrayList getAllInParams()
public java.util.ArrayList getAllOutParams()
public java.util.ArrayList getOutParams()
public void addFault(FaultDesc fault)
public java.util.ArrayList getFaults()
public FaultDesc getFaultByClass(java.lang.Class cls)
public FaultDesc getFaultByClass(java.lang.Class cls, boolean checkParents)
public FaultDesc getFaultByQName(QName qname)
public FaultDesc getFaultByXmlType(QName xmlType)
public ParameterDesc getReturnParamDesc()
public java.lang.String toString()
public java.lang.String toString(java.lang.String indent)
public int getMessageOperationStyle()
public void setMessageOperationStyle(int messageOperationStyle)
public javax.wsdl.OperationType getMep()
public void setMep(javax.wsdl.OperationType mep)
public void setMep(java.lang.String mepString)
mepString
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |