|
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.DSEProcessor
com.ibm.btt.automaton.ext.DSEOperationProcessor
public class DSEOperationProcessor
This class provides the behaviour of the processor class plus the required Operation interface. It allows to model operations as state machines by handling the actual steps of the operation as actions inside the different states that an operation flow may have. See DSEStep to see how specific steps may be built using this approach for business operation flows.
Field Summary |
---|
Fields inherited from class com.ibm.btt.automaton.DSEProcessor |
---|
ABORTED, aProcessorStatusChangedListener, CHANGESTATE, CLEAN_EVENTS_QUEUE_ON_SWITCH, cleanQueueOnSwitch, COMPLETED, context, currentState, eventQueue, externalizer, INITIALIZED, NOT_INITIALIZED, processorId, processorName, RUNNING, stateTag, status, STATUSCHANGEEVENT, SUSPENDED, TERMINATEEVENT |
Fields inherited from class com.ibm.btt.base.DSENotifier |
---|
handlersList, name |
Fields inherited from interface com.ibm.btt.automaton.Processor |
---|
COMPID |
Constructor Summary | |
---|---|
DSEOperationProcessor()
This constructor creates a DSEProcessorOperation object. |
|
DSEOperationProcessor(boolean mustRegister)
This constructor creates a DSEProcessorOperation object. |
|
DSEOperationProcessor(java.lang.String aName)
This constructor creates a DSEProcessorOperation object. |
|
DSEOperationProcessor(java.lang.String aName,
java.lang.String aTID)
This constructor creates a DSEProcessorOperation object. |
Method Summary | |
---|---|
DataElement |
addElement(DataElement aDataElement)
Adds an element aDataElement to the KeyedCollection of the context. |
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 operation process. |
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()
Gets the formats property (com.ibm.btt.base.Hashtable) value. |
KeyedCollection |
getKeyedCollection()
Returns the context keyedCollection. |
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. |
java.lang.Object |
initializeFormatFrom(Tag aTag)
This method finds, instantiates, and adds the format element referred to by aTag, into the operation's formats. |
java.lang.Object |
initializeFrom(Tag aTag)
This method uses the processor's Tag attributes to initialize a Processor with an Id and a context. |
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 value of the applicationId property. |
void |
setContextName(java.lang.String aContextName)
This method sets the context identifier to aContextName. |
void |
setFormats(Hashtable formats)
Sets the formats property (com.ibm.btt.base.Hashtable) value. |
void |
setKeyedCollection(KeyedCollection aKeyedCollection)
Sets the operation context keyed collection to aKeyedCollection. |
void |
setType(java.lang.String aType)
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 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 class com.ibm.btt.base.DSENotifier |
---|
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, signalEvent |
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 |
---|
execute, getContext, getName, setContext, setName |
Methods inherited from interface com.ibm.btt.base.Cacheable |
---|
isCacheable, reinitialize |
Methods inherited from interface com.ibm.btt.automaton.Processor |
---|
addHandler, getHandlersList, signalEvent |
Methods inherited from interface com.ibm.btt.base.Externalizable |
---|
getName, setName |
Constructor Detail |
---|
public DSEOperationProcessor()
public DSEOperationProcessor(java.lang.String aName)
aName
- java.lang.Stringpublic DSEOperationProcessor(java.lang.String aName, java.lang.String aTID)
aName
- java.lang.StringaTID
- java.lang.Stringpublic DSEOperationProcessor(boolean mustRegister)
mustRegister
- booleanMethod 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)
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() throws DSEInvalidRequestException, DSEObjectNotFoundException
close
in interface Processor
close
in interface Operation
close
in class DSEProcessor
DSEInvalidRequestException
DSEObjectNotFoundException
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
setFormats(com.ibm.btt.base.Hashtable)
public KeyedCollection getKeyedCollection() throws DSEInvalidRequestException
getKeyedCollection
in interface Operation
DSEInvalidRequestException
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 DSEProcessor
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 java.lang.Object initializeFormatFrom(Tag aTag) throws java.io.IOException
aTag
- com.ibm.btt.base.Tag
java.io.IOException
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException, DSEProcessorException
initializeFrom
in class DSEProcessor
aTag
- com.ibm.btt.base.Tag Contains the name and attributes of the
object to be created.
java.io.IOException
- The object can not be created.
DSEException
DSEProcessorException
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 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
aContextName
- Stringpublic void setFormats(Hashtable formats)
formats
- The new value for the property.getFormats()
public void setKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidRequestException
setKeyedCollection
in interface Operation
aKeyedCollection
- KeyedCollection
DSEInvalidRequestException
public void setType(java.lang.String aType) throws DSEInvalidRequestException
setType
in interface Operation
aType
- String
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() and throws a DSEObjectNotFoundException if the data element is not found.
setValueAt
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
DSEInvalidArgumentException
public void unchain() throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.
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 |