|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface for a processor that manages the flow of the business logic.
Field Summary | |
---|---|
static java.lang.String |
COMPID
|
Method Summary | |
---|---|
void |
abort()
Aborts the process. |
void |
addHandler(Handler aHandler,
java.lang.String eventName)
Adds a aHandler to the chain of handlers for the object implementing the Processor interface. |
void |
addProcessorStatusChangedListener(ProcessorStatusChangedListener param)
Adds a listener to the processor's STATUSCHANGEEVENT and TERMINATEDEVENT. |
void |
changeState(java.lang.String newState,
boolean changeStateIgnoringEntryActionsValue)
Changes the state (by name) of the process. |
void |
close()
Closes actions and releases the processor and context objects. |
Context |
getContext()
Returns the value of the Context property. |
State |
getCurrentState()
Return the CurrentState of the process. |
java.lang.String |
getCurrentStateType()
Returns the current State's Type. |
Queue |
getEventQueue()
Returns the value of the eventQueue property. |
Hashtable |
getHandlersList()
Returns a Hashtable containing the list of Handlers listening to this process. |
Tag |
getInitialStateTag()
Returns the tag for the initial state. |
java.lang.String |
getProcessorId()
Returns the value of the processorId property. |
java.lang.String |
getProcessorName()
Returns the value of the processorName property. |
Tag |
getStateTag(java.lang.String stateName)
Returns the tag for the state name passed in as a parameter. |
Vector |
getStateTagList()
Returns a vector of states possible for this process. |
java.lang.String |
getStatus()
Returns the status of the process. |
Tag |
getTag()
Returns the tag associated with the process. |
void |
initialize()
Initiates the process. |
void |
resume()
Resumes a suspended processor. |
void |
setContext(Context aContext)
Sets the context to the process. |
void |
setCurrentState(State newState)
Sets the value of the currentState property. |
void |
setCurrentStateType(java.lang.String newStateType)
Sets the value of the CurrentStateType property. |
void |
setProcessorId(java.lang.String newProcessorId)
Sets the value of the processorId property. |
void |
setProcessorName(java.lang.String externalizedId)
Sets the value of the processorName property. |
void |
setStatus(java.lang.String aStatus)
Sets the status of the process. |
void |
setTag(Tag aTag)
Sets the tag of the process. |
void |
signalEvent(DSEEventObject anEvent)
Signals an event to the operation. |
void |
suspend()
Suspends the process. |
void |
terminate()
Provides housekeeping for the Processor object as a notifier instance. |
Methods inherited from interface com.ibm.dse.automaton.Executable |
---|
execute |
Methods inherited from interface com.ibm.dse.base.Cacheable |
---|
getName, isCacheable, reinitialize |
Field Detail |
public static final java.lang.String COMPID
Method Detail |
public void abort() throws DSEProcessorException
DSEProcessorException
public void addHandler(Handler aHandler, java.lang.String eventName) throws DSEInvalidArgumentException
The handler, which is added to the chain of handlers using this operation, is registered for the event anEventName to be signaled by the DSENotifier. If it is interested in any event signaled by this notifier, the event name must be set to allEvents.
This method generates a DSEInvalidArgumentException when aHandler or anEventName are null.
aHandler
- com.ibm.dse.base.HandlereventName
- java.lang.String
DSEInvalidArgumentException
public void addProcessorStatusChangedListener(ProcessorStatusChangedListener param)
param
- com.ibm.dse.automaton.ProcessorStatusChangedListenerpublic void changeState(java.lang.String newState, boolean changeStateIgnoringEntryActionsValue) throws DSEProcessorException
newState
- java.lang.String
DSEProcessorException
public void close() throws DSEInvalidRequestException, DSEObjectNotFoundException
DSEInvalidRequestException
DSEObjectNotFoundException
public Context getContext()
public State getCurrentState()
public java.lang.String getCurrentStateType()
public Queue getEventQueue()
public Hashtable getHandlersList()
public Tag getInitialStateTag()
public java.lang.String getProcessorId()
public java.lang.String getProcessorName()
public Tag getStateTag(java.lang.String stateName)
stateName
- java.lang.String
public Vector getStateTagList()
public java.lang.String getStatus()
public Tag getTag()
public void initialize() throws java.io.IOException, DSEException
java.io.IOException
DSEException
DSEProcessorException
public void resume()
public void setContext(Context aContext)
aContext
- com.ibm.dse.base.Contextpublic void setCurrentState(State newState)
newState
- Statepublic void setCurrentStateType(java.lang.String newStateType)
newStateType
- java.lang.Stringpublic void setProcessorId(java.lang.String newProcessorId)
newProcessorId
- java.lang.Stringpublic void setProcessorName(java.lang.String externalizedId)
externalizedId
- java.lang.Stringpublic void setStatus(java.lang.String aStatus)
aStatus
- java.lang.Stringpublic void setTag(Tag aTag)
aTag
- com.ibm.dse.base.Tagpublic void signalEvent(DSEEventObject anEvent)
public void suspend()
public void terminate() throws DSEException
DSEException
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |