Package org.apache.axis.description
Class OperationDesc
java.lang.Object
org.apache.axis.description.OperationDesc
- All Implemented Interfaces:
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 Summary
FieldsModifier and TypeFieldDescriptionprotected static org.apache.commons.logging.Log
static Map
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.OperationDesc
(String name, ParameterDesc[] parameters, QName returnQName) "Complete" constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addParameter
(QName paramName, QName xmlType, Class javaType, byte parameterMode, boolean inHeader, boolean outHeader) void
addParameter
(ParameterDesc param) Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.get the documentation for the operationgetFaultByClass
(Class cls) Returns the FaultDesc for the fault class given.getFaultByClass
(Class cls, boolean checkParents) Returns the FaultDesc for the fault class given.getFaultByQName
(QName qname) Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault).getFaultByXmlType
(QName xmlType) Returns the FaultDesc for an XMLType.getInputParamByQName
(QName qname) javax.wsdl.OperationType
getMep()
int
getName()
Return the operation's nameint
int
int
Returns an ordered list of out params (NOT inouts)getOutputParamByQName
(QName qname) getParamByQName
(QName qname) getParameter
(int i) getStyle()
Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.getUse()
Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.boolean
Is the return value in the header of the response message?void
setDocumentation
(String documentation) set the documentation for the operationvoid
setElementQName
(QName elementQName) void
Set the MEP using a string like "request-response"void
setMep
(javax.wsdl.OperationType mep) void
setMessageOperationStyle
(int messageOperationStyle) void
void
Set the operation's namevoid
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
(QName returnQName) void
setReturnType
(QName returnType) void
setSoapAction
(String soapAction) void
void
toString()
-
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
-
log
protected static org.apache.commons.logging.Log log
-
-
Constructor Details
-
OperationDesc
public OperationDesc()Default constructor. -
OperationDesc
"Complete" constructor
-
-
Method Details
-
getName
Return the operation's name -
setName
Set the operation's name -
getDocumentation
get the documentation for the operation -
setDocumentation
set the documentation for the operation -
getReturnQName
-
setReturnQName
-
getReturnType
-
setReturnType
-
getReturnClass
-
setReturnClass
-
getElementQName
-
setElementQName
-
getParent
-
setParent
-
getSoapAction
-
setSoapAction
-
setStyle
-
getStyle
Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set. -
setUse
-
getUse
Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set. -
addParameter
-
addParameter
-
getParameter
-
getParameters
-
setParameters
Set the parameters wholesale.- Parameters:
newParameters
- an ArrayList of ParameterDescs
-
getNumInParams
public int getNumInParams() -
getNumOutParams
public int getNumOutParams() -
getNumParams
public int getNumParams() -
getMethod
-
setMethod
-
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
-
getInputParamByQName
-
getOutputParamByQName
-
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
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
Returns an ordered list of out params (NOT inouts) -
addFault
-
getFaults
-
getFaultByClass
Returns the FaultDesc for the fault class given. Returns null if not found. -
getFaultByClass
Returns the FaultDesc for the fault class given. Returns null if not found. -
getFaultByQName
Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault). Returns null if not found. -
getFaultByXmlType
Returns the FaultDesc for an XMLType. Returns null if not found. -
getReturnParamDesc
-
toString
-
toString
-
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
Set the MEP using a string like "request-response"- Parameters:
mepString
-
-