org.eclipse.stardust.engine.api.model
Interface ProcessDefinition

All Superinterfaces:

EventAware, ModelElement, Serializable

public interface ProcessDefinition
extends ModelElement, EventAware

The client view of a workflow process.

A process definition normally comprises a number of discrete activity steps, with associated computer and/or human operations and rules governing the progression of the process through the various activity steps.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Activity	getActivity(String id) Gets the specified activity.
List	getAllActivities() Gets all activities defined for this process definition.
List	getAllDataPaths() Gets all data paths defined for this process definition.
List	getAllTriggers() Gets all triggers defined for this process definition.
DataPath	getDataPath(String id) Gets the specified data path.
ProcessInterface	getDeclaredProcessInterface() Gets the process interface implemented by this process definition.
ProcessDefinitionDetailsLevel	getDetailsLevel() Retrieves the level of detail for process definition.
ProcessInterface	getImplementedProcessInterface() Gets the process interface implemented by this process definition.
long	getRuntimeElementOID() Gets the runtime OID of the model element.

Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelElement

getAllAttributes, getAttribute, getDescription, getElementOID, getId, getModelOID, getName, getNamespace, getPartitionId, getPartitionOID, getQualifiedId

Methods inherited from interface org.eclipse.stardust.engine.api.model.EventAware

getAllEventHandlers, getEventHandler

Method Detail

getRuntimeElementOID

long getRuntimeElementOID()

Gets the runtime OID of the model element.

Contrary to the element OID, runtime element OIDs are guaranteed to be stable over model versions for model elements of same type and identical fully qualified IDs.

The fully qualified ID of a model element consists of the concatenation of the fully qualified element ID of its parent element, if existent, and the element ID.

Returns:

the runtime model element OID

See Also:

ModelElement.getElementOID()

getAllDataPaths

List getAllDataPaths()

Gets all data paths defined for this process definition.

Returns:

a List of DataPath objects.

getDataPath

DataPath getDataPath(String id)

Gets the specified data path.

Parameters:

id - the ID of the data path.

Returns:

the requested data path.

getDetailsLevel

ProcessDefinitionDetailsLevel getDetailsLevel()

Retrieves the level of detail for process definition.

Returns:

the process instance details level.

getAllActivities

List getAllActivities()

Gets all activities defined for this process definition.

Returns:

a List of Activity objects.

getActivity

Activity getActivity(String id)

Gets the specified activity.

Parameters:

id - the ID of the activity.

Returns:

the requested activity.

getAllTriggers

List getAllTriggers()

Gets all triggers defined for this process definition.

Returns:

a List of Trigger objects.

getImplementedProcessInterface

ProcessInterface getImplementedProcessInterface()

Gets the process interface implemented by this process definition.

Returns:

the ProcessInterface or null if this process do not implement an interface.

getDeclaredProcessInterface

ProcessInterface getDeclaredProcessInterface()

Gets the process interface implemented by this process definition.

Returns:

the ProcessInterface or null if this process do not implement an interface.