Package com.aquima.interactions.process.impl

Class ProcessDefinition

java.lang.Object

com.aquima.interactions.process.impl.ProcessDefinition

All Implemented Interfaces:

IProcessDefinition

public class ProcessDefinition
extends Object
implements IProcessDefinition

This class holds the static definition of a process.

Since:

7.1

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProcessDefinition(IProcessEngineDefinitions processEngineDefinitions, IProject project, IProcessFlowDS datasource, IExpressionParser parser)

Method Summary

Modifier and Type	Method	Description
void	addAdHocTask(IProcessNodeDefinition task)
void	addEventStartDefinition(IProcessEventStartDefinition eventStart)
void	addExitEvent(ProcessExit processExit)
IProcessStepDefinition[]	getAdhocProcessTasks()	This method returns an array containing the process (tasks) that should be scheduled whenever their conditions are met.
String	getDescription()	This method returns a description of the process.
IMultilingualText	getDisplayName()	This method returns the display name for the process.
IProcessEventStartDefinition[]	getEventStartDefinitions()	This method returns the definitions of how to start this process by a message event.
String[]	getExitStates()	This method returns all exit states of the process.
GUID	getId()	This method returns the ID of the process.
String	getName()	This method returns the name of the process.
protected IProcessEngineDefinitions	getProcessEngineDefinitions()
ProcessExit	getProcessExit(String exitState)	This method returns the processexit for a certain exit state.
IRole[]	getRoles()	This method returns an array containing the roles that are required for the process.
IProcessNodeDefinition	getStartNode()	This method returns the start node of the process.
protected ProcessTypeDefinition	getType()
String	getTypeName()	This method returns the name of the type of the process.
void	setStartNode(IProcessNodeDefinition startNode)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ProcessDefinition

protected ProcessDefinition(IProcessEngineDefinitions processEngineDefinitions,
 IProject project,
 IProcessFlowDS datasource,
 IExpressionParser parser)

Method Details

getId

public GUID getId()

Description copied from interface: IProcessDefinition

This method returns the ID of the process.

Specified by:

getId in interface IProcessDefinition

Returns:

the ID of the process, may not be null.

getName

public String getName()

Description copied from interface: IProcessDefinition

This method returns the name of the process.

Specified by:

getName in interface IProcessDefinition

Returns:

the name of the process.

getDescription

public String getDescription()

Description copied from interface: IProcessDefinition

This method returns a description of the process.

Specified by:

getDescription in interface IProcessDefinition

Returns:

a description of the process.

getDisplayName

public IMultilingualText getDisplayName()

Description copied from interface: IProcessDefinition

This method returns the display name for the process.

Specified by:

getDisplayName in interface IProcessDefinition

Returns:

the display name for the process.

getType

protected ProcessTypeDefinition getType()

getTypeName

public String getTypeName()

Description copied from interface: IProcessDefinition

This method returns the name of the type of the process.

Specified by:

getTypeName in interface IProcessDefinition

Returns:

the name of the type of the process.

addAdHocTask

public void addAdHocTask(IProcessNodeDefinition task)

getAdhocProcessTasks

public IProcessStepDefinition[] getAdhocProcessTasks()

Description copied from interface: IProcessDefinition

This method returns an array containing the process (tasks) that should be scheduled whenever their conditions are met. The conditions of these tasks will be checked whenever the case data changes, and the current process is still active.

Specified by:

getAdhocProcessTasks in interface IProcessDefinition

Returns:

an array containing the process (tasks) that should be scheduled whenever their conditions are met.

getRoles

public IRole[] getRoles()

Description copied from interface: IProcessDefinition

This method returns an array containing the roles that are required for the process.

Specified by:

getRoles in interface IProcessDefinition

Returns:

array containing the roles that are required for the process.

getStartNode

public IProcessNodeDefinition getStartNode()

Description copied from interface: IProcessDefinition

This method returns the start node of the process. This node is used to start a subprocess or for the deprecated api call createCase

Specified by:

getStartNode in interface IProcessDefinition

Returns:

the start node of the process.

setStartNode

public void setStartNode(IProcessNodeDefinition startNode)

getExitStates

public String[] getExitStates()

Description copied from interface: IProcessDefinition

This method returns all exit states of the process.

Specified by:

getExitStates in interface IProcessDefinition

Returns:

The names of the exit states, never null.

getProcessExit

public ProcessExit getProcessExit(String exitState)

Description copied from interface: IProcessDefinition

This method returns the processexit for a certain exit state.

Specified by:

getProcessExit in interface IProcessDefinition

Returns:

The exit definition for a state.

toString

public String toString()

Overrides:

toString in class Object

getEventStartDefinitions

public IProcessEventStartDefinition[] getEventStartDefinitions()

Description copied from interface: IProcessDefinition

This method returns the definitions of how to start this process by a message event.

Specified by:

getEventStartDefinitions in interface IProcessDefinition

Returns:

an array of start definitions

getProcessEngineDefinitions

protected IProcessEngineDefinitions getProcessEngineDefinitions()

addExitEvent

public void addExitEvent(ProcessExit processExit)

addEventStartDefinition

public void addEventStartDefinition(IProcessEventStartDefinition eventStart)
                             throws InitializationException

Throws:

InitializationException