abort()
COPYRIGHT
static final java.lang.String COPYRIGHT
- See Also:
- Constant Field Values
COMPID
static final java.lang.String COMPID
- See Also:
- Constant Field Values
abort
void abort()
throws DSEProcessorException
- Aborts the process.
- Throws:
DSEProcessorException
addHandler
void addHandler(ProcessorHandler aHandler,
java.lang.String eventName)
throws DSEInvalidArgumentException
- Adds a aHandler to the chain of handlers for the object
implementing the Processor interface. The handler is located in the first
position of the chain so that 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, the event name must be set to allEvents.
This method generates a DSEInvalidArgumentException when
aHandler or anEventName are null.
- Parameters:
aHandler - com.ibm.btt.base.HandlereventName - java.lang.String
- Throws:
DSEInvalidArgumentException
addProcessorStatusChangedListener
void addProcessorStatusChangedListener(ProcessorStatusChangedListener param)
- Adds a listener to the processor's STATUSCHANGEEVENT and TERMINATEDEVENT.
- Parameters:
param - com.ibm.btt.automaton.ProcessorStatusChangedListener
changeState
void changeState(java.lang.String newState,
boolean changeStateIgnoringEntryActionsValue)
throws DSEProcessorException
- Changes the state (by name) of the process.
- Parameters:
newState - java.lang.StringignoreEntryActionsValue - boolean
- Throws:
DSEProcessorException
close
void close()
throws DSEInvalidRequestException,
DSEObjectNotFoundException
- Closes actions and releases the processor and context objects.
- Throws:
DSEInvalidRequestException
DSEObjectNotFoundException
getContext
Context getContext()
- Returns the value of the Context property.
- Returns:
- com.ibm.btt.base.Context - the current instance of Context
getCurrentState
State getCurrentState()
- Return the CurrentState of the process.
- Returns:
- com.ibm.btt.automaton.State - the instance of the CurrentState
getCurrentStateType
java.lang.String getCurrentStateType()
- Returns the current State's Type.
- Returns:
- java.lang.String
getEventQueue
Queue getEventQueue()
- Returns the value of the eventQueue property.
- Returns:
- com.ibm.btt.automaton.Queue
getHandlersList
Hashtable getHandlersList()
- Returns a Hashtable containing the list of Handlers listening to
this process.
- Returns:
- com.ibm.btt.base.Hashtable
getInitialStateTag
Tag getInitialStateTag()
- Returns the tag for the initial state.
- Returns:
- com.ibm.btt.base.Tag
getProcessorId
java.lang.String getProcessorId()
- Returns the value of the processorId property.
- Returns:
- java.lang.String
getProcessorName
java.lang.String getProcessorName()
- Returns the value of the processorName property.
- Returns:
- java.lang.String
getStateTag
Tag getStateTag(java.lang.String stateName)
- Returns the tag for the state name passed in as a parameter.
- Parameters:
stateName - java.lang.String
- Returns:
- com.ibm.btt.base.Tag
getStateTagList
Vector getStateTagList()
- Returns a vector of states possible for this process.
- Returns:
- com.ibm.btt.base.Vector
getStatus
java.lang.String getStatus()
- Returns the status of the process.
- Returns:
- java.lang.String
getTag
Tag getTag()
- Returns the tag associated with the process.
- Returns:
- com.ibm.btt.base.Tag
initialize
void initialize()
throws java.io.IOException,
DSEException
- Initiates the process.
- Throws:
java.io.IOException
DSEException
DSEProcessorException
resume
void resume()
- Resumes a suspended processor.
setContext
void setContext(Context aContext)
- Sets the context to the process.
- Parameters:
aContext - com.ibm.btt.base.Context
setCurrentState
void setCurrentState(State newState)
- Sets the value of the currentState property.
- Parameters:
newState - State
setCurrentStateType
void setCurrentStateType(java.lang.String newStateType)
- Sets the value of the CurrentStateType property.
- Parameters:
newStateType - java.lang.String
setProcessorId
void setProcessorId(java.lang.String newProcessorId)
- Sets the value of the processorId property.
- Parameters:
newProcessorId - java.lang.String
setProcessorName
void setProcessorName(java.lang.String externalizedId)
- Sets the value of the processorName property.
- Parameters:
externalizedId - java.lang.String
setStatus
void setStatus(java.lang.String aStatus)
- Sets the status of the process.
- Parameters:
aStatus - java.lang.String
setTag
void setTag(Tag aTag)
- Sets the tag of the process.
- Parameters:
aTag - com.ibm.btt.base.Tag
signalEvent
void signalEvent(BTTProcessorEventObject anEvent)
- Signals an event to the operation. 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. anEventName event contains, as attributes, as much
information as is required to process it. The information is held in the
params hashtable. Required notifier interface implementors must define
themselves as a source of a standard Java event (that awakes all the
listeners waiting for it). The signalEvent method can then be overwritten
to add the statement that fires the event in the standard Java way.
Additional methods to add and remove listeners must also be implemented
as defined in the Java development guide.
- Parameters:
param - com.ibm.btt.base.DSEEventObject
suspend
void suspend()
- Suspends the process.
terminate
void terminate()
throws DSEException
- Provides housekeeping for the Processor object as a notifier instance.
This is called either from the application or from the context when it is
destroyed or unchained. Subclasses should overwrite this implementation
to perform the actions required to release the resources acquired by the
notifier.
- Throws:
DSEException
(c) Copyright IBM Corporation 1998, 2009
|