Package wt.workflow.engine

Provides workflow classes responsible for the flow of control and data from an execution point of view.

See:
          Description

Interface Summary
WfEngineService This class WfEngineService represents the client accessible API to the workflow engine.
WfEngineServiceSvr The WfEngineServiceSvr interface contains the server accessible API.
WfNode WfNode is an interface representing the objects that may occur in a workflow graph.
WfRequester WfRequester is an interface for classes that serve as adapters of WfProcess in different usage scenarios.
 

Class Summary
ActivityActivityLink The ActivityActivityLink represents associations between workflow steps.
ActivityConnectorLink The ActivityConnectorLink associates steps to connectors.
ConnectorActivityLink The ConnectorActivityLink joins connectors to activities.
ConnectorConnectorLink The ConnectorConnectorLink class joins connectors to connectors.
FiredLinkVector FiredLinkVector holds links that fired a connector so consecutive firings of a same link are not counted twice The links are stored as ids.
MigrateWfProcess_R4ToR5  
MigrateWfQueueEntries Migrate all 6.2.6 ScheduleQueueEntry amd QueueEntry objects to equivalent 7.0 entries.
ProcessData The ProcessData represents data used by execution objects.
SourceHistoryLink Use the newSourceHistoryLink static factory method(s), not the SourceHistoryLink constructor, to construct instances of this class.
StandardWfEngineService Standard implementation of the workflow engine service.
StandardWfEngineService.SynchRobotCache Internal class for creation of distributed cache that maps event keys to oids of synchronization robots.
SynchedWorkflow  
WfActivity WfActivity represents a request for work in the context of the containing WfProcess.
WfAdHocActivity Use the newWfAdHocActivity static factory method(s), not the WfAdHocActivity constructor, to construct instances of this class.
WfAssigneeNotification This class is to be used for variable modification of the parameters associated with overdue (eg.
WfAssignmentEventAudit WfAssignmentEventAudit specializes WfEventAudit for assignment change events.
WfBlock The WfBlock class supports the execution of blocks.
WfConnector The WfConnector class represents logical sequencing combinations between workflow steps.
WfConnectorAction WfConnectorType enumerates the possible actions that can be carried out by connectors.
WfConnectorEvent WfConnectorType enumerates the possible events that can be produced by connectors.
WfConnectorFunction The WfConnectorFunction class enumerates the possible functions a connector may have.
WfConnectorState The WfConnectorState class enumerates the possible states a connector may be in.
WfConnectorType WfConnectorType enumerates the possible types of connectors.
WfContainer

Supported API: false

Extendable: false
WfContainerReference Use the newWfContainerReference static factory method(s), not the WfContainerReference constructor, to construct instances of this class.
WfCreateProcessEventAudit WfCreateProcessEventAudit specializes WfEventAudit by adding information related to creation of a WfProcess.
WfCustomEvent Workflow event that can be emitted with an arbitrary payload.
WfDataEventAudit WfDataEventAudit specializes WfEventAudit for data change events.
WfDueDate This class is to be used for variable modification of a process' or activity's deadline Date.
WfDuration This class is to be used for variable modification of a process' or activity's deadline duration..
WfEngineHelper Helper class that provides client access to the WfEngineService API.
WfEngineServerHelper WfEngineServerHelper is an auxiliary class to provide access to server only functionality to the workflow engine.
WfEngineServiceEvent Keyed event emitted by the workflow engine caused by a change or exception in an execution object.
WfEngineServiceFwd This class WfEngineService represents the client accessible API to the workflow engine.
WfEventAudit The WfEventAudit provides audit records of workflow event information.
WfEventAuditType WfEventAuditType enumerates the types of events that may occur in the execution of a process that may be recorded or emitted as a keyed event.
WfEventConfiguration WfEventConfiguration controls the execution behavior of the obejct.
WfEventHelper Creates and stores workflow events.
WfEventHelper.SaveEventAudit Runnable class that implements the saving of event audits.
WfExceptionActionType The WfExceptionActionType enumerates the possible actions to be taken when an execution object is overdue.
WfExceptionEventAudit WfExceptionrEventAudit specializes WfEventAudit for execution error events.
WfExecutionObject WfExecutionObject is an abstract base class that defines common attributes, states and operations for processes and steps.
WfInstruction This class is for use by WfVariable to hold dynamic activity instructions.
WfLink Abstract base class for non-control workflow link objects.
WfMonitor  
WfOverdueActionType The WfOverdueActionType enumerates the possible actions to be taken when an execution object is overdue.
WfProcess A WfProcess is the performer of a workflow.
WfProcessReference WfProcessReference represents references to a given workflow processes.
WfProcessRequester The WfProcessRequester class implements WfRequester to allow processes to be used by external applications.
WfRequesterActivity The WfRequesterActivity class implements WfRequester to allow processes to be embedded in other processes.
WfRouterType The WfRouterType enumerates the possible routing properties of a workflow step (node).
WfState The WfState class enumerates the possible states an execution object may be in.
WfStateEventAudit This class specializes WfEventAudit by adding state change information.
WfTemplateProcessor WfTemplateProcessor provides support for the generation of execution time notification.
WfTransition Used together with the State type to define the state transitions anexecution object can perform when it is in a particular state.
WfVariable Name-value pair.
WfVotingEventAudit Use the newWfVotingEventAudit static factory method(s), not the WfVotingEventAudit constructor, to construct instances of this class.
 

Exception Summary
AlreadyRunningException Thrown if an attempt is made to start a WfExecutionObject that is already running.
CannotCompleteException Thrown if an attempt is made to complete execution of a WfActivity when it cannot be completed.
CannotResumeException Thrown when an attempt is made to perform invalid resume operation on a WfExecutionObject.
CannotStartException Thrown if an attempt is made to start a WfExecutionObject that can't be started.
CannotStopException Thrown when an attempt is made to perform invalid stop operation on a WfExecutionObject.
CannotSuspendException Thrown when an attempt is made to perform invalid suspend operation on a WfExecutionObject.
DataMissingException Exception thrown when a value is not provided for a required variable when an execution object is started.
FailedExpressionException This exception is thrown when a robot expression returns 'false.'

Supported API: false

Extendable: false
FailedTransitionException This exception is thrown when a transition expression returns 'false.'

Supported API: false

Extendable: false
HistoryNotAvailableException Thrown when a request is made for the event audit history of an WfExecutionObject when the history is not available.
InvalidDataException Thrown in case an attempt is made to update the context of the result of a WfExecutionObject with data that do match the signature of that object.
InvalidPerformerException Thrown when an attempt is made to signal a WfEventAudit to a WfRequester that was not created by the WfProcess associated with the WfRequester.
InvalidStateException Thrown when and attempt is made to change the state of a WfExecutionObject to a state that is not defined for that object.
NotRunningException Thrown when an attempt is made to perform invalid operation on a WfExecutionObject that requires the object be in a running state.
ResultNotAvailableException Thrown if the requested result of a WfExecutionObject is not available.
SourceNotAvailableException Thrown by a request for the source of a WfEventAudit when the source is no longer available.
TransitionNotAllowedException Thrown if an attempt is made to perform an invalid state transition of a WfExecutionObject.
 

Package wt.workflow.engine Description

Provides workflow classes responsible for the flow of control and data from an execution point of view.

The Workflow Engine Package

This package contains the classes responsible for the workflow enactment. Workflows are represented by processes (WfProcess objects) or blocks (WfBlock objects) that are composed of activities (WfActivity objects or WfAdhocActivity objects). Each activity may be performed by humans (WfAssignedActivity and WfAdhocActivity), or by applications (represented by a WfRobotActivity object). Finally, an activity may also be a reference (represented by a WfRequesterActivity object).

Both WfProcess and WfActivity classes extend the WfExecutionObject. WfExecutionObject is responsible mainly for object identification, state maintenance (allowing only valid transitions), and information holding.

 

Workflow Engine Package Diagram