public class MDefaultOperationDescription extends MRegistryObjectWithProperties implements MOperationDescription, MObjWithIdSort.HasIdString, MOperationConstants
MDefaultOperationDescription describes an operation of a class object
K_CLOSURE, K_EXCEPTION_DATA, K_EXCEPTION_NAME, K_HAS_EXCEPTION, K_REPLY, K_REQUEST, K_RETURN_VALUE, K_USER_CLOSURE
Modifier and Type | Method and Description |
---|---|
void |
addException(MOperationExceptionDescription e)
Add this exception to this operation.
|
MOperationExceptionDescription |
addException(java.lang.String exceptionName,
com.tibco.infra.base.GlobalName exceptionClassName)
Create an exception as specified and attach it to this operation;
|
MOperationExceptionDescription |
addException(java.lang.String exceptionName,
MClassDescription exceptionClass)
Create an exception as specified and attach it to this operation;
|
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)
Register an implementation
|
void |
addParameter(MOperationParameterDescription p)
Add this parameter to this operation.
|
MOperationParameterDescription |
addParameter(java.lang.String parameterName,
com.tibco.infra.base.GlobalName parameterClassName,
java.lang.String defaultValueStr,
int direction)
Create a parameter as specified and attach it to this operation;
The order of addtion of parameters can be important in some cases of invocation.
|
MOperationParameterDescription |
addParameter(java.lang.String parameterName,
MClassDescription parameterClass,
java.lang.Object defaultValue,
int direction)
Create a parameter as specified and attach it to this operation;
The order of addtion of parameters can be important in some cases of invocation.
|
MOperationParameterDescription |
addParameter(java.lang.String parameterName,
java.lang.String parameterClassName,
java.lang.String defaultValueStr,
int direction)
Create a parameter as specified and attach it to this operation;
The order of addtion of parameters can be important in some cases of invocation.
|
MClassDescription |
getDeclaringClassDescription()
Return the class description that this operation is a part of
|
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.
|
java.lang.String |
getIdAsString()
Return the id of the object as a string
|
int |
getInputParameterSize() |
MOperationImpl |
getOperationImpl(java.lang.Object implementationId) |
java.lang.String |
getOperationName()
Return the name of the operation
|
MOperationParameterDescription |
getParameter(java.lang.String name)
Return the named parameter, or null if not found
|
java.util.Enumeration |
getParameters()
Enumerate over the list of parameters.
|
MClassDescription |
getParametersClassDescription() |
java.lang.String |
getReplyClassName() |
java.lang.String |
getRequestClassName() |
MClassDescription |
getResultAndExceptionClassDescription() |
MClassDescription |
getReturnClassDescription()
Return the class description of this operation's returned value
|
boolean |
isOK() |
boolean |
isOK(java.lang.StringBuffer errorReason) |
boolean |
isOneway()
Return true if invoking this operation results in no returned value,
either through the operation value or the out parameters
|
java.lang.String |
toString()
Return the string representation of this object
|
void |
unregisterImpl(java.lang.Object implementationId)
Unregister an implementation based on id
|
addProperty, getProperties, getProperty, getPropertyCount, getPropertyNames, getRegistry
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getProperties, getProperty, getPropertyCount, getPropertyNames
public void addException(MOperationExceptionDescription e) throws MException
MException
- On duplicated exception ( detected by name comparison )public MOperationExceptionDescription addException(java.lang.String exceptionName, com.tibco.infra.base.GlobalName exceptionClassName) throws MException
addException
in interface MOperationDescription
MException
- On duplicated exception ( detected by name comparison )MOperationDescription.addException(String, String)
public MOperationExceptionDescription addException(java.lang.String exceptionName, java.lang.String exceptionClassName) throws MException
MOperationDescription
addException
in interface MOperationDescription
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).MOperationDescription.addException(String, MClassDescription)
,
MOperationDescription.addParameter(String, MClassDescription, Object, int)
public MOperationExceptionDescription addException(java.lang.String exceptionName, MClassDescription exceptionClass) throws MException
addException
in interface MOperationDescription
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 )MOperationDescription.addException(String, String)
,
MOperationDescription.addParameter(String, MClassDescription, Object, int)
public void addParameter(MOperationParameterDescription p) throws MException
MException
- On duplicated parameter ( detected by name comparison )public MOperationParameterDescription addParameter(java.lang.String parameterName, com.tibco.infra.base.GlobalName parameterClassName, java.lang.String defaultValueStr, int direction) throws MException
addParameter
in interface MOperationDescription
MException
- On duplicated parameter ( detected by name comparison )MOperationDescription.addParameter(String, String, String, int)
public MOperationParameterDescription addParameter(java.lang.String parameterName, java.lang.String parameterClassName, java.lang.String defaultValueStr, int direction) throws MException
addParameter
in interface MOperationDescription
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
- On duplicated parameter ( detected by name comparison )public MOperationParameterDescription addParameter(java.lang.String parameterName, MClassDescription parameterClass, java.lang.Object defaultValue, int direction) throws MException
addParameter
in interface MOperationDescription
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
- On duplicated parameter ( detected by name comparison )public MClassDescription getDeclaringClassDescription()
getDeclaringClassDescription
in interface MMemberDescription
public MOperationExceptionDescription getException(java.lang.String name)
getException
in interface MOperationDescription
public java.util.Enumeration getExceptions()
getExceptions
in interface MOperationDescription
public java.lang.String getIdAsString()
getIdAsString
in interface MObjWithIdSort.HasIdString
public java.lang.String getOperationName()
getOperationName
in interface MOperationDescription
public MOperationParameterDescription getParameter(java.lang.String name)
getParameter
in interface MOperationDescription
public java.util.Enumeration getParameters()
getParameters
in interface MOperationDescription
public MClassDescription getReturnClassDescription()
getReturnClassDescription
in interface MOperationDescription
public boolean isOneway()
isOneway
in interface MOperationDescription
public void addImplementation(java.lang.String implementationId, MOperationImpl impl) throws MDuplicateException
addImplementation
in interface MOperationDescription
MDuplicateException
- On attempt to bind more than 1 implementation to an idpublic MOperationImpl getOperationImpl(java.lang.Object implementationId)
getOperationImpl
in interface MOperationDescription
public java.lang.String toString()
toString
in class java.lang.Object
public void unregisterImpl(java.lang.Object implementationId)
public MClassDescription getParametersClassDescription()
getParametersClassDescription
in interface MOperationDescription
public MClassDescription getResultAndExceptionClassDescription()
getResultAndExceptionClassDescription
in interface MOperationDescription
public boolean isOK()
isOK
in interface MMetaDescription
isOK
in class MRegistryObjectWithProperties
public boolean isOK(java.lang.StringBuffer errorReason)
isOK
in interface MMetaDescription
isOK
in class MRegistryObjectWithProperties
public java.lang.String getRequestClassName()
getRequestClassName
in interface MOperationDescription
public java.lang.String getReplyClassName()
getReplyClassName
in interface MOperationDescription
public int getInputParameterSize()
getInputParameterSize
in interface MOperationDescription