org.jwarp.flow.model
Interface IWorkflowSystem

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

WorkflowSystem

public interface IWorkflowSystem

extends IConfigurable

Interface describing the whole workflow system. Basically a workflow system is the summery of several workflow models.

Method Summary

void	addModel(IWorkflowModel model) Add a model.
java.util.Date	getCreationDate() Return the creation date (start of this generation).
IFormManager	getFormManager() Get the form factory.
int	getGeneration() Return the generation counter (starting at 1).
java.util.Iterator	getModels() Get the models.
IParticipantManager	getParticipants() Get the participant subservice.
IRoleManager	getRoles() Get the role subservice.
IScreenManager	getScreenManager() Get the screen factory.
ITransitionManager	getTransitionManager() Get the transition instances subservice.
void	removeModel(IWorkflowModel model) Remove a model.
void	startWorkflow(java.lang.String id, Parameter[] params) Start a workflow with the given parameters

Methods inherited from interface org.jwarp.service.configuration.IConfigurable

configure

Method Detail

getGeneration

public int getGeneration()

Return the generation counter (starting at 1).

Returns:

The generation

getCreationDate

public java.util.Date getCreationDate()

Return the creation date (start of this generation).

Returns:

The creation date

getParticipants

public IParticipantManager getParticipants()

Get the participant subservice.

Returns:

The participant subservice

getRoles

public IRoleManager getRoles()

Get the role subservice.

Returns:

The role subservice

getScreenManager

public IScreenManager getScreenManager()

Get the screen factory.

Returns:

The screen factory service

getFormManager

public IFormManager getFormManager()

Get the form factory.

Returns:

The form factory service

getTransitionManager

public ITransitionManager getTransitionManager()

Get the transition instances subservice.

Returns:

The transition instances subservice

getModels

public java.util.Iterator getModels()

Get the models.

Returns:

The models

addModel

public void addModel(IWorkflowModel model)

Add a model.

Parameters:

The - model

removeModel

public void removeModel(IWorkflowModel model)

Remove a model.

Parameters:

The - model to be removed

startWorkflow

public void startWorkflow(java.lang.String id,
                          Parameter[] params)
                   throws NotFoundException,
                          InitializationException,
                          TransitionInitException,
                          ParameterException,
                          ParameterNotFoundException

Start a workflow with the given parameters

Parameters:

The - id string of the workflow (Form: ModelName.FlowName)

The - parameters for initializing the first transition

Throws:

NotFoundException - If the workflow requested could not be located

InitException - If the initialization of the workflow failed basically

TransitionInitException - If the first transition could not be initialised, that means if parameters are invalid or missing

ParameterException - If the first transition validation failed, that means if parameters are invalid

ParameterNotFoundException - If the first transition validation failed, that means if parameters are missing