|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.DSENotifier
com.ibm.btt.automaton.DSEAction
com.ibm.btt.automaton.ext.DSEStep
public abstract class DSEStep
This class is the base class which any step defined as an action inside a process flow definition should inherit from. This class implements the base Operation interface protocol providing access to the context and the formats defined for the processor under which the step is running.
Field Summary |
---|
Fields inherited from class com.ibm.btt.automaton.DSEAction |
---|
context, inputMapFmtTag, operationTag, outputMapFmtTag, sourceEvent, tag |
Fields inherited from class com.ibm.btt.base.DSENotifier |
---|
handlersList, name |
Constructor Summary | |
---|---|
DSEStep()
This constructor creates a DSEAction object. |
Method Summary | |
---|---|
DataElement |
addElement(DataElement aDataElement)
Adds an element aDataElement to the KeyedCollection of the processor. |
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 whatever housekeeping process before ending the processor. |
void |
execute()
This method executes the executeStep of the step, that should be provided by any subclass of DSEStep and then signals the ok or error events according to the success of the execution |
abstract void |
executeStep()
This method must be implemented by the subclasses in order to perform the specific steps. |
java.lang.String |
getApplicationId()
Returns the value of the applicationId property. |
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. |
protected DSEOperationProcessor |
getOperationProcessor()
This method returns the instance of DSEOperationProcessor which this step is running under. |
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 processor. |
java.lang.String |
getType()
Returns the action context type. |
java.lang.Object |
getValueAt(java.lang.String aCompositeKey)
Returns value of the data element identified by aConpositeKey. |
boolean |
isCacheable()
This method returns false to indicate that this object is not supposed to be stored into the cache. |
boolean |
isChained()
Returns true if the context is chained to the hierarchy. |
void |
prune()
Removes the context from the hierarchy. |
void |
reinitialize()
As long as the object is not cacheable, there is no need for reinitialization. |
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 value of the applicationId property. |
void |
setContextName(java.lang.String aContextName)
Sets the context name to aContextName. |
void |
setKeyedCollection(KeyedCollection aKeyedCollection)
Sets the context keyed collection to aKeyedCollection. |
void |
setType(java.lang.String aContextType)
Sets the 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 receiving 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 class com.ibm.btt.automaton.DSEAction |
---|
chainOrAssignContext, chainOrAssignContext, close, evaluateGuardCondition, externalizer, getContext, getGuardConditions, getInputMapFmtTag, getOperationTag, getOutputMapFmtTag, getParms, getProcessor, getSourceEvent, initializeFrom, mapTheInput, mapTheOutput, preProcess, readExternal, readExternal, removeExternal, setContext, setGuardConditions, setInputMapFmtTag, setOperationTag, setOutputMapFmtTag, setParms, setProcessor, setSourceEvent, toString, toStrings, toTags, writeExternal, writeExternal |
Methods inherited from class com.ibm.btt.base.DSENotifier |
---|
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, signalEvent, terminate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.btt.base.Operation |
---|
getContext, getName, setContext, setName |
Methods inherited from interface com.ibm.btt.automaton.Action |
---|
getName, setName |
Methods inherited from interface com.ibm.btt.base.Notifier |
---|
addHandler, getHandlersList, removeHandler, signalEvent, signalEvent, terminate |
Methods inherited from interface com.ibm.btt.base.Externalizable |
---|
getName, setName |
Constructor Detail |
---|
public DSEStep()
Method Detail |
---|
public DataElement addElement(DataElement aDataElement) throws DSEInvalidRequestException
This method throws a DSEInvalidRequestException.
addElement
in interface Operation
aDataElement
- DataElement
DSEInvalidRequestException
public void addOperationRepliedListener(OperationRepliedListener newListener)
Operation
addOperationRepliedListener
in interface Operation
newListener
- com.ibm.btt.base.OperationRepliedListenerpublic void chainTo(Context aContext) throws DSEInvalidRequestException
This method throws a DSEInvalidRequestException.
chainTo
in interface Operation
DSEInvalidRequestException
public void close()
close
in interface Action
close
in interface Operation
close
in class DSEAction
public void execute()
execute
in interface Action
execute
in interface Operation
execute
in class DSEAction
public abstract void executeStep() throws java.lang.Exception
java.lang.Exception
public java.lang.String getApplicationId()
getApplicationId
in interface Operation
public java.lang.String getContextName()
getContextName
in interface Operation
public DataElement getElementAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
getElementAt
in interface Operation
DSEObjectNotFoundException
public java.lang.Object getFormat(java.lang.String aFormatName) throws DSEInvalidArgumentException
getFormat
in interface Operation
DSEInvalidArgumentException
public Hashtable getFormats()
getFormats
in interface Operation
public KeyedCollection getKeyedCollection() throws DSEInvalidRequestException
getKeyedCollection
in interface Operation
DSEInvalidRequestException
protected DSEOperationProcessor getOperationProcessor()
public Context getParent() throws DSEInvalidRequestException
getParent
in interface Operation
DSEInvalidRequestException
public Service getService(java.lang.String aServiceName) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the service is not found.
getService
in interface Operation
getService
in class DSEAction
DSEObjectNotFoundException
public java.lang.String getType() throws DSEInvalidRequestException
getType
in interface Operation
DSEInvalidRequestException
public java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the data element is not found.
getValueAt
in interface Operation
DSEObjectNotFoundException
public boolean isCacheable()
isCacheable
in interface Cacheable
public boolean isChained() throws DSEInvalidRequestException
isChained
in interface Operation
DSEInvalidRequestException
public void prune() throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.
prune
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
public void reinitialize()
reinitialize
in interface Cacheable
public DataElement removeAt(java.lang.String aCompositeKey) throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.
removeAt
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
public void removeOperationRepliedListener(OperationRepliedListener newListener)
removeOperationRepliedListener
in interface Operation
newListener
- com.ibm.btt.base.OperationRepliedListenerpublic void setApplicationId(java.lang.String appId)
setApplicationId
in interface Operation
appId
- String The new value of the applicationId.public void setContextName(java.lang.String aContextName)
setContextName
in interface Operation
public void setKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidRequestException
setKeyedCollection
in interface Operation
aKeyedCollection
- KeyedCollection
DSEInvalidRequestException
public void setType(java.lang.String aContextType) throws DSEInvalidRequestException
setType
in interface Operation
DSEInvalidRequestException
public void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue) throws DSEObjectNotFoundException, DSEInvalidArgumentException
This method throws a DSEInvalidRequestException if the data type doesn't allow a setValue().
This method throws a DSEObjectNotFoundException if the data is not found.
setValueAt
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
DSEInvalidArgumentException
public void unchain() throws DSEInvalidRequestException, DSEObjectNotFoundException
The parent attribute is se to null and the receiving context is removed from the children list in the parent context. The receiving context cannot have children.
This method throws a DSEInvalidRequestException and a DSEObjectNotFoundException.
Refer to the Context class unchain method.
unchain
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
public java.lang.String[] xValidate()
xValidate
in interface Operation
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |