|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ATTR(value={"id#String#REQUIRED","implClass#String#IMPLIED","context#String#IMPLIED","xVal#String#IMPLIED"}) public interface Operation
Operation interface. This is the generic interface for any operation. Any object implementing this interface must provide the corresponding protocol for initializing, executing, and closing the operation, as well as providing the corresponding context protocol to handle the operation as a context (get/set objects from/to its context, get formats and services, etc.).
Method Summary | |
---|---|
DataElement |
addElement(DataElement aDataElement)
Adds an element "aDataElement" to the KeyedCollection of the operation. |
void |
addOperationRepliedListener(OperationRepliedListener newListener)
Adds an operation replied listener. |
void |
chainTo(Context aContext)
Sets the receiving context as a child of "aContext" and as the new current child. |
void |
close()
This method must include any housekeeping process before ending the operation process. |
void |
execute()
This method must provide the whole operation flow process. |
java.lang.String |
getApplicationId()
Returns the applicationId. |
Context |
getContext()
Returns the operation context. |
java.lang.String |
getContextName()
Returns the context name. |
DataElement |
getElementAt(java.lang.String aCompositeKey)
Returns the DataElement identified by the aCompositeKey parameter. |
java.lang.Object |
getFormat(java.lang.String aFormatName)
Returns the formatElement named aFormatName from the formats Hashtable. |
Hashtable |
getFormats()
* Returns the operation formats Hashtable. |
KeyedCollection |
getKeyedCollection()
Returns the context keyedCollection. |
java.lang.String |
getName()
Returns the operation name. |
Context |
getParent()
Returns the Context object defined as the parent context of the operation context. |
Service |
getService(java.lang.String aServiceName)
Returns the service named aServiceName from the chain of contexts attached to the operation. |
java.lang.String |
getType()
Returns the operation context type. |
java.lang.Object |
getValueAt(java.lang.String aCompositeKey)
Returns value of the data element identified by aConpositeKey. |
boolean |
isChained()
Returns true if the operation context is chained to the hierarchy. |
void |
prune()
Removes the operation context from the hierarchy. |
DataElement |
removeAt(java.lang.String aCompositeKey)
Removes the data element identified by aCompositeKey from the context data collection. |
void |
removeOperationRepliedListener(OperationRepliedListener newListener)
Removes the operation replied listener. |
void |
setApplicationId(java.lang.String appId)
Sets the operation application id to applicationId. |
void |
setContext(Context aContext)
Sets the operation context to aContext. |
void |
setContextName(java.lang.String aContextName)
This method sets the context identifier to aContextName. |
void |
setKeyedCollection(KeyedCollection aKeyedCollection)
Sets the operation context keyed collection to aKeyedCollection. |
void |
setName(java.lang.String name)
Sets the operation name to name. |
void |
setType(java.lang.String aContextType)
Sets the operation context type to aContextType. |
void |
setValueAt(java.lang.String aCompositeKey,
java.lang.Object aDataValue)
Sets the value of the data identified by aCompositeKey to aDataValue. |
void |
unchain()
Removes the operation context from the context hierarchy. |
java.lang.String[] |
xValidate()
Returns a String that indicates if the validation has been achieved successfully or not. |
Methods inherited from interface com.ibm.btt.base.Cacheable |
---|
isCacheable, reinitialize |
Method Detail |
---|
DataElement addElement(DataElement aDataElement) throws DSEInvalidRequestException
DSEInvalidRequestException
void chainTo(Context aContext) throws DSEInvalidRequestException
DSEInvalidRequestException
void close() throws DSEInvalidRequestException, DSEObjectNotFoundException
DSEInvalidRequestException
DSEObjectNotFoundException
void execute() throws java.lang.Exception
java.lang.Exception
java.lang.String getApplicationId()
Context getContext()
java.lang.String getContextName()
DataElement getElementAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
DSEObjectNotFoundException
java.lang.Object getFormat(java.lang.String aFormatName) throws DSEInvalidArgumentException
DSEInvalidArgumentException
Hashtable getFormats()
KeyedCollection getKeyedCollection() throws DSEInvalidRequestException
DSEInvalidRequestException
java.lang.String getName()
getName
in interface Cacheable
Context getParent() throws DSEInvalidRequestException
DSEInvalidRequestException
java.lang.String getType() throws DSEInvalidRequestException
DSEInvalidRequestException
java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
DSEObjectNotFoundException
boolean isChained() throws DSEInvalidRequestException
DSEInvalidRequestException
void prune() throws DSEInvalidRequestException, DSEObjectNotFoundException
DSEInvalidRequestException
DSEObjectNotFoundException
DataElement removeAt(java.lang.String aCompositeKey) throws DSEInvalidRequestException, DSEObjectNotFoundException
DSEInvalidRequestException
DSEObjectNotFoundException
void setApplicationId(java.lang.String appId)
name
- java.lang.Stringvoid setContext(Context aContext)
void setContextName(java.lang.String aContextName)
void setKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidRequestException
DSEInvalidRequestException
void setName(java.lang.String name)
name
- java.lang.Stringvoid setType(java.lang.String aContextType) throws DSEInvalidRequestException
DSEInvalidRequestException
void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue) throws DSEObjectNotFoundException, DSEInvalidArgumentException
DSEObjectNotFoundException
DSEInvalidArgumentException
void unchain() throws DSEInvalidRequestException, DSEObjectNotFoundException
DSEInvalidRequestException
DSEObjectNotFoundException
java.lang.String[] xValidate()
Service getService(java.lang.String aServiceName) throws DSEObjectNotFoundException
DSEObjectNotFoundException
void addOperationRepliedListener(OperationRepliedListener newListener)
newListener
- com.ibm.btt.base.OperationRepliedListenervoid removeOperationRepliedListener(OperationRepliedListener newListener)
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |