org.imixs.workflow
Interface Model

All Known Subinterfaces:

ExtendedModel

public interface Model

A Model defines the instructions for processing a workitem. The Model is used by the WorkflowKernel to manage the process flow of a workitem in the workflow. A Model is defined by collections of ProcessEntities which defines a state for a worktiem inside the model and ActivityEntities which defines the transition from one state to another. The Model interface defines finder functions to get processEntities and activityEntities. A processEntity contains informations about the Processinstance inside the workflowmodel e.g. the name or the statusdescription. On the other point of view a activityentity contains informations about the processcontroling and processhandling. A ProcessEntity is defined by its processid. A ActivityEntity defined by its activityid and unambiguously assigned to a ProcessEntity by its processid. The Workflowkernel determines by analyzing the workitem the appendant activityentity and transfers it along with the workitem to the registerd plugin moduls. After processing the workitem the workflowkernel is able to analyze the new status of the workitem by the informations stored inside the appendant processentity. With a Model the Workflowkernel is able to controle the expiration of a workflowprocess. A Model is always instantiated by a WorkflowManager and transferd as a Interface to the Workflowkernel.

Version:

1.0

Author:

Ralph Soika

See Also:

WorkflowManager, Plugin

Method Summary

ItemCollection	getActivityEntity(int processid, int activityid) Finds and returns the ActivityEntity for a processid and a activityid inside the Model.
java.util.Collection<ItemCollection>	getActivityEntityList(int processid) retruns a collection of ActivityEntities for a specivic ProcessID.
ItemCollection	getProcessEntity(int processid) Finds and returns the ProcessEntity for a processid inside the Model.
java.util.Collection<ItemCollection>	getProcessEntityList() retruns a collection of ProcessEntities

Method Detail

getProcessEntity

ItemCollection getProcessEntity(int processid)
                                throws java.lang.Exception

Finds and returns the ProcessEntity for a processid inside the Model.

Parameters:

processid -

Returns:

ItemCollection

Throws:

java.lang.Exception

getActivityEntity

ItemCollection getActivityEntity(int processid,
                                 int activityid)
                                 throws java.lang.Exception

Finds and returns the ActivityEntity for a processid and a activityid inside the Model.

Parameters:

processid -

activityid -

Returns:

ItemCollection

Throws:

java.lang.Exception

getProcessEntityList

java.util.Collection<ItemCollection> getProcessEntityList()
                                                          throws java.lang.Exception

retruns a collection of ProcessEntities

Returns:

Collection org.imixs.workflow.ItemCollection

Throws:

java.lang.Exception

getActivityEntityList

java.util.Collection<ItemCollection> getActivityEntityList(int processid)
                                                           throws java.lang.Exception

retruns a collection of ActivityEntities for a specivic ProcessID. If the process ID did not exists an empty collection should be returned

Returns:

Collection org.imixs.workflow.ItemCollection

Throws:

java.lang.Exception