Package de.danet.an.workflow.api

This package defines the the workflow API provided by Danet's workflow component.

See:
Description

Interface Summary

Activity	Interface Activity adds some functions to the OMG activity.
Activity.Implementation	The super interface of possible activity implementation descriptions.
Activity.SubFlowImplementation	This interface describes the implementation of an activity by a sub flow.
Activity.ToolImplementation	This interface describes the implementation of an activity by a tool.
Application	This interface defines methods to access the definition of an application that participates in a workflow process.
Batch	This interface must be implemented by classes that can be run as batch.
Batch.Context	This interface specifies a simple contract between a batch and its execution environment.
Channel	This interface defines a named connection with a process that can be used to receive messages from activities and send messages to activities.
Configuration	Interface Configuration.
EventSubscriber	An EventSubscriber represents a connection to the workflow engine's event queue.
ExecutionObject	Interface ExecutionObject extends the OMG execution object with additional methods that allow the type-safe state class to be used to query and set state.
ExternalReference	This interface represents an ExternalReference as specified by XPDL.
GroupResource	This interface extends the interface WfResource for resources that are groups.
Participant	This interface identifies the data type "workflow participant" in a ProcessDataInfo object.
Process	Interface Process adds some functions to the OMG process.
ProcessClosedAuditEvent	A ProcessClosedAuditEvent extends the WfStateAuditEvent.
ProcessDefinition	This interface defines a process definiton.
ProcessDefinition.PackageHeaderData	An interface providing the information from the package definition header section.
ProcessDefinition.ProcessHeaderData	An interface providing the information from the process definition header section.
ProcessDefinitionDirectory	This interface defines a process definiton directory.
ProcessDirectory	Client interface for the process directory.
ProcessMgr	Interface ProcessMgr adds some functions to the OMG process manager.
RangeAccess	This interface defines paginated access to data.
RoleResource	This interface extends the interface WfResource for resources that are roles.
SAXEventBuffer	This interface is implemented by classes that can provide XML content by emitting SAX events.
Transition	Represents a transition between two activities.
UserResource	This interface extends the interface WfResource for resources that are users.
WorkflowService	This interface defines the methods provided by the workflow engine.

Class Summary

Activity.ClosedCompletedState	This class defines the sub-states of ClosedState.COMPLETED of a WfExecutionObject.
Activity.DeadlineInfo	Class DeadlineInfo describes all properties of a deadline.
Activity.Info	Class Info combines various informational attributes about an activity in a single structure for efficient retrieval.
Activity.JoinAndSplitMode	This class defines the join and split modes for an activity.
Activity.StartFinishMode	This class defines the values for start and finish mode for an Activity.
ActivityUniqueKey	This class implements a unique activity key.
DefaultProcessData	This class extends HashMap in order to provide a default implementation of ProcessData.
DefaultRequester	This class provides an implementation of a WfRequester.
FormalParameter	This class provides a description of a formal parameter as used for workflow processes and workflow applications.
FormalParameter.Mode	Defines a class for representing priorities in a type save way.
MethodInvocationBatch	This class provides a Batch implementation that executes several invocations of remote objects on the server in a single transaction and returns the results.
Participant.ParticipantType	This class defines the participant type for a participant.
PrioritizedMessage	This class presents a prioritized message that will be internationalized using the specified resource bundle and the referenced entry.
PrioritizedMessage.Priority	This class represents the priority of a given message.
WorkflowServiceFactory	This class provides a factory API that enables clients to obtain a workflow service facility.

Exception Summary

AlreadyAssignedException	This class provides ...
CannotRemoveException	This exception is raised by an attempt to remove a WfProcess that is still in progress.
ImportException	This exception is thrown by the importProcessDefinitions method of ProcessDefinitionDirectory and results from collected errors.
InvalidIdException	This exception is raised if an invalid id is passed to a lookup method.
InvalidKeyException	This exception is raised if an invalid key is passed to a lookup method.
NoSuchResourceException	This exception is thrown if a resource has become invalid.

Error Summary

FactoryConfigurationError

This exception is thrown by the newInstance method of WorkflowServiceFactory.

Package de.danet.an.workflow.api Description

This package defines the the workflow API provided by Danet's workflow component. The API extends the core API derived from the OMG "Workflow Management Facility Sepcification, V1.2". We consider the interfaces and classes in this package (together with the interfaces and classes in the core API) to be useable as a general Java workflow API, i.e. if there was a JSR for a Java workflow API, we think the merger of these two packages would be a good starting point.

Trying to implement workflow clients using the OMG interface, we found that it lacks some functions that are either absolutely necessary or nice to have. For some OMG interfaces we have therefore defined a corresponding interface that extends the OMG base interface.

We have also added some interface for areas that the OMG specification has purposely omitted from its scope (e.g. access to process definitions).

Finally, the OMG specification has left it open how to access the root objects of type WfProcessMgr. We have therefore defined a WorkflowService and its corresponding factory that provides this access (among some other useful function).

Since:

V1.0