|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface for a process which manages the flow of the business logic.
Field Summary | |
static java.lang.String |
COMPID
|
Method Summary | |
void |
abort()
This is invoked to abort 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)
Methods adds a listener to the processor's STATUSCHANGEEVENT and TERMINATEDEVENT. |
void |
changeState(java.lang.String newState,
boolean changeStateIgnoringEntryActionsValue)
This is invoked to change the state (by name) of the process. |
void |
close()
This method is for closing actions and releasing 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()
Return the current State's Type. |
Queue |
getEventQueue()
Returns the value of the eventQueue property. |
Hashtable |
getHandlersList()
Returns a hastable containing the list of Handlers listening to this Process. |
Tag |
getInitialStateTag()
This method 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)
This method returns the tag for the state name passed in as a parameter. |
Vector |
getStateTagList()
Return a vector of states possible for this process. |
java.lang.String |
getStatus()
Return the status of the process. |
Tag |
getTag()
Return the tag associated with the process. |
void |
initialize()
This initiates the process. |
void |
resume()
This is invoked to resume a suspended processor. |
void |
setContext(Context aContext)
Set 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)
Set the status of the process. |
void |
setTag(Tag aTag)
Set the tag of the process. |
void |
signalEvent(DSEEventObject anEvent)
The operation must call the dispatch method of the first handler registered for this event, proceed according to the defined event propagation criteria, and follow the chain of handlers. |
void |
suspend()
This is invoked to suspend the process. |
void |
terminate()
Provides housekeeping for the Processor object as a notifier instance. |
Methods inherited from interface com.ibm.dse.automaton.Executable |
execute |
Field Detail |
public static final java.lang.String COMPID
Method Detail |
public void abort() throws DSEProcessorException
public void addHandler(Handler aHandler, java.lang.String eventName) throws DSEInvalidArgumentException
The handler is located in the first position of the chain so it is the first handler to receive the event when signaled.
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, then 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.Stringpublic void addProcessorStatusChangedListener(ProcessorStatusChangedListener param)
param
- com.ibm.dse.automaton.ProcessorStatusChangedListenerpublic void changeState(java.lang.String newState, boolean changeStateIgnoringEntryActionsValue) throws DSEProcessorException
newState
- java.lang.StringignoreEntryActionsValue
- booleanpublic void close() throws 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.Stringpublic Vector getStateTagList()
public java.lang.String getStatus()
public Tag getTag()
public void initialize() throws java.io.IOException, DSEException
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)
param
- com.ibm.dse.base.DSEEventObjectpublic void suspend()
public void terminate() throws DSEException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |