public interface MOperationDescription extends MMemberDescription
MOperationDescription
describes an operation for an
object. It is used by the SDK to encapsulate an operation description
defined in the repository with the operation association list inside
a class object. Applications can also use it to programmatically
generate operation descriptions.Modifier and Type | Method and Description |
---|---|
MOperationExceptionDescription |
addException(java.lang.String exceptionName,
com.tibco.infra.base.GlobalName exceptionClassName)
Deprecated.
as of TIBCO Adapter SDK Version 5.0.0
|
MOperationExceptionDescription |
addException(java.lang.String exceptionName,
MClassDescription exceptionClass)
Create an exception as specified and make it part of this operation description.
|
MOperationExceptionDescription |
addException(java.lang.String exceptionName,
java.lang.String exceptionClassName)
Create an exception as specified and make it part of this operation description.
|
void |
addImplementation(java.lang.String implementationId,
MOperationImpl impl) |
MOperationParameterDescription |
addParameter(java.lang.String parameterName,
com.tibco.infra.base.GlobalName parameterClassName,
java.lang.String defaultValueStr,
int direction)
Deprecated.
as of TIBCO Adapter SDK Version 5.0.0
|
MOperationParameterDescription |
addParameter(java.lang.String parameterName,
MClassDescription parameterClass,
java.lang.Object defaultValue,
int direction)
Create a parameter as specified and make it part of this operation
description.
|
MOperationParameterDescription |
addParameter(java.lang.String parameterName,
java.lang.String parameterClassName,
java.lang.String defaultValueStr,
int direction)
Create a parameter as specified and make it part of this operation
description.
|
MOperationExceptionDescription |
getException(java.lang.String name)
Return the named exception, or null if not found.
|
java.util.Enumeration |
getExceptions()
Enumerate over the list of exceptions.
|
int |
getInputParameterSize() |
MOperationImpl |
getOperationImpl(java.lang.Object multiplexId) |
java.lang.String |
getOperationName()
Return the name of the operation.
|
MOperationParameterDescription |
getParameter(java.lang.String name)
Return the specified parameter.
|
java.util.Enumeration |
getParameters()
Enumerate over the list of parameters.
|
MClassDescription |
getParametersClassDescription()
Deprecated.
|
java.lang.String |
getReplyClassName()
Deprecated.
|
java.lang.String |
getRequestClassName()
Deprecated.
|
MClassDescription |
getResultAndExceptionClassDescription()
Deprecated.
|
MClassDescription |
getReturnClassDescription()
Return the class description of the return value specified by this operation description.
|
boolean |
isOneway()
Return true if invoking this operation results in no returned value,
either through the operation value or the out parameters.
|
getDeclaringClassDescription
getProperties, getProperty, getPropertyCount, getPropertyNames, isOK, isOK
java.lang.String getOperationName()
MClassDescription getReturnClassDescription()
boolean isOneway()
MOperationParameterDescription getParameter(java.lang.String name)
java.util.Enumeration getParameters()
Enumeration.nextElement()
can be cast to MOperationParameterDescription
.MOperationParameterDescription addParameter(java.lang.String parameterName, MClassDescription parameterClass, java.lang.Object defaultValue, int direction) throws MException
parameterName
- Name of the parameter to be added to this operation description.parameterClass
- Class of the parameter to be
added to this operation description.defaultValue
- Default value for this parameter.direction
- One of IN
, OUT
, INOUT
.
The legal values are defined in MOperationParameterDescription
.MException
- if this is a duplicated parameter (detected by name comparison).MOperationParameterDescription addParameter(java.lang.String parameterName, com.tibco.infra.base.GlobalName parameterClassName, java.lang.String defaultValueStr, int direction) throws MException
MException
addParameter(String, String, String, int)
MOperationParameterDescription addParameter(java.lang.String parameterName, java.lang.String parameterClassName, java.lang.String defaultValueStr, int direction) throws MException
parameterName
- Name of the parameter to be added to this operation description.parameterClassName
- Class of the parameter to be
added to this operation description.defaultValueStr
- Default value for this parameter.MException
- if this is a duplicated parameter (detected by name comparison).MOperationExceptionDescription getException(java.lang.String name)
java.util.Enumeration getExceptions()
Enumeration.nextElement()
can be cast to MOperationExceptionDescription
.MOperationExceptionDescription addException(java.lang.String exceptionName, MClassDescription exceptionClass) throws MException
exceptionName
- Name of the exception to add to this operation description.exceptionClass
- exceptionClassName Class of
the exception to be added to this operation description. This exception must
be described in the metadata document.MException
- on duplicated exception (detected by name comparison).addException(String, String)
,
addParameter(String, MClassDescription, Object, int)
MOperationExceptionDescription addException(java.lang.String exceptionName, com.tibco.infra.base.GlobalName exceptionClassName) throws MException
MException
addException(String, String)
MOperationExceptionDescription addException(java.lang.String exceptionName, java.lang.String exceptionClassName) throws MException
exceptionName
- Name of the exception to add to this operation description.exceptionClassName
- Class name of
the exception to be added to this operation description. This exception must
be described in the metadata document.MException
- on duplicated exception (detected by name comparison).addException(String, MClassDescription)
,
addParameter(String, MClassDescription, Object, int)
MClassDescription getParametersClassDescription()
MClassDescription getResultAndExceptionClassDescription()
MOperationImpl getOperationImpl(java.lang.Object multiplexId) throws MOperationException
MOperationException
void addImplementation(java.lang.String implementationId, MOperationImpl impl) throws MDuplicateException
MDuplicateException
java.lang.String getRequestClassName()
java.lang.String getReplyClassName()
int getInputParameterSize()