com.simplicite.bpm

Class ProcessusCore

java.lang.Object

com.simplicite.bpm.ProcessusCore

All Implemented Interfaces:

CacheInterface, java.io.Serializable

Direct Known Subclasses:

Processus

public class ProcessusCore
extends java.lang.Object
implements java.io.Serializable, CacheInterface

Process core methods

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	CANCEL Cancel right
static char	NEW Instantiation right
static char	READ Read right
static char	STATE_CANCELED
static char	STATE_DONE
static char	STATE_RUNNING
static char	STATE_STARTED
static int	TYPE_ACTIVITY Activity workflow (multi-users with persistence)
static int	TYPE_GUI Deprecated. Use TYPE_SCREENFLOW
static int	TYPE_SCREENFLOW Screen workflow (mono-user without persistence)
static char	UNIT_DAY Duration unit DAY
static char	UNIT_HOUR Duration unit HOUR
static char	UNIT_MINUTE Duration unit MINUTE
static char	UNIT_MONTH Duration unit MONTH
static char	UNIT_SECOND Duration unit SECOND
static char	UNIT_YEAR Duration unit YEAR

Constructor Summary

Constructors

Constructor and Description
ProcessusCore()

Method Summary

Modifier and Type	Method and Description
void	addActivity(Activity a) Add one activity to the process
void	addPermission(java.lang.String group, char grant) Add permission
void	addSharedScript(Script s) Add a shared script
void	addTransition(java.lang.String id, java.lang.String name, java.lang.String from, java.lang.String to, java.lang.String condition, java.lang.String callback, Alert alert, Action action) Add a transition between 2 activities
void	delPermission(java.lang.String group, char grant) Delete permission
void	enableGC(boolean enabled) Enable or disable the internal GC
boolean	garbageCollection() Garbage collection of dynamic data
java.util.List<Activity>	getActivities() Get all activities
Activity	getActivity(java.lang.String step) Get the activity of a given step
Alert	getAlert() Deadline alert, may be null
Activity	getBegin() Get the begin activity
java.lang.String	getCacheKey(Grant g) Get process unique cache key
java.lang.String	getCompensationProcess() Compensation process
ProcessusData	getData() Process dynamic data
java.lang.String	getDeadline(java.util.Date dt) Get the process deadline
java.lang.String	getDisplay() Process translation
Activity	getEnd() Get the end activity
Grant	getGrant() Get the rights of the process user
java.lang.String	getId() Unique process definition id
Activity	getMainActivity() Get he main activity if exists
char	getMainObjectCascadeDelete() Get cascade deletion of business process when main object is deleted
java.lang.String	getName() Process name
java.util.List<Transition>	getNext(java.lang.String step) Get all transition from a given step without any condition
Transition	getNext(java.lang.String step, java.lang.String condition, java.lang.String action, java.lang.String nextStep) Get the available transition with a given condition.
java.util.List<Transition>	getNextActions(java.lang.String step) Get all transitions with user Actions from a given step
java.util.List<Transition>	getNextActions(java.lang.String step, boolean enabledOnly) Get all transitions with user Actions from a given step
ActivityFile	getParentContext() Parent context in case of a sub-process
java.util.Map<java.lang.String,java.lang.String>	getPermissions() Get all permissions by group:function where function = R, N or C
int	getPersistenceDepth()
java.lang.String	getPID() Get the process instance row id (bpm_process_file)
java.util.List<Activity>	getPrevious(java.lang.String step) Get all previous activities from a step
static java.lang.String	getProcessId(java.lang.String name) Get process row Id from name
static java.lang.String	getProcessName(java.lang.String rowId) Get process name from rowId
java.lang.Object	getProcessParameter(java.lang.String name) Get a process parameter
ProcessRoad	getProcessRoad()
java.lang.String	getScriptId() Get server script document ID
java.util.List<Script>	getSharedScripts() Get all shared scripts
java.lang.String	getShortName() Process short name
Transition	getTransition(java.lang.String name) Get a transition
java.util.List<Transition>	getTransitions() Get all transitions
int	getType() Process type
void	initProcessRoad()
boolean	isCancelGranted(Grant g)
boolean	isCancelGranted(java.lang.String group)
boolean	isMultiUsers()
boolean	isNewGranted(Grant g)
boolean	isNewGranted(java.lang.String group)
boolean	isReadGranted(Grant g)
boolean	isReadGranted(java.lang.String group)
boolean	isScreenFlow()
long	lastUsage(boolean update) Last usage timestamp (last access to process engine)
boolean	persistWhenTerminated() Persist process in DB when terminated ?
java.lang.String	readScript(boolean force) Read server script document content (read using getScriptId())
void	removeProcessParameter(java.lang.String name) Remove a process parameter
void	setAlert(Alert a)
void	setCompensationProcess(java.lang.String name)
void	setData(ProcessusData data)
void	setDisplay(java.lang.String d)
void	setDuration(int max, char unit) Set the max duration of the process (then send the deadline alert)
void	setGrant(Grant g)
void	setId(java.lang.String id)
void	setMainActivityStep(java.lang.String step) Set the main activity of the process
void	setMainObjectCascadeDelete(char del) Set cascade deletion of business process when main object is deleted
void	setName(java.lang.String name)
void	setParentContext(ActivityFile context)
void	setPersistenceWhenTerminated(boolean b, int depth)
void	setPID(java.lang.String pid)
void	setProcessParameter(java.lang.String name, java.lang.Object value) Set a process parameter
void	setScriptId(java.lang.String id) Set server script document ID
void	setShortName(java.lang.String name)
void	setType(int type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATE_STARTED

public static final char STATE_STARTED

See Also:

Constant Field Values

STATE_RUNNING

public static final char STATE_RUNNING

See Also:

Constant Field Values

STATE_DONE

public static final char STATE_DONE

See Also:

Constant Field Values

STATE_CANCELED

public static final char STATE_CANCELED

See Also:

Constant Field Values

TYPE_SCREENFLOW

public static final int TYPE_SCREENFLOW

Screen workflow (mono-user without persistence)

See Also:

Constant Field Values

TYPE_GUI

@Deprecated
public static final int TYPE_GUI

Deprecated. Use TYPE_SCREENFLOW

See Also:

Constant Field Values

TYPE_ACTIVITY

public static final int TYPE_ACTIVITY

Activity workflow (multi-users with persistence)

See Also:

Constant Field Values

READ

public static final char READ

Read right

See Also:

Constant Field Values

NEW

public static final char NEW

Instantiation right

See Also:

Constant Field Values

CANCEL

public static final char CANCEL

Cancel right

See Also:

Constant Field Values

UNIT_YEAR

public static final char UNIT_YEAR

Duration unit YEAR

See Also:

Constant Field Values

UNIT_MONTH

public static final char UNIT_MONTH

Duration unit MONTH

See Also:

Constant Field Values

UNIT_DAY

public static final char UNIT_DAY

Duration unit DAY

See Also:

Constant Field Values

UNIT_HOUR

public static final char UNIT_HOUR

Duration unit HOUR

See Also:

Constant Field Values

UNIT_MINUTE

public static final char UNIT_MINUTE

Duration unit MINUTE

See Also:

Constant Field Values

UNIT_SECOND

public static final char UNIT_SECOND

Duration unit SECOND

See Also:

Constant Field Values

Constructor Detail

ProcessusCore

public ProcessusCore()

Method Detail

getProcessId

public static java.lang.String getProcessId(java.lang.String name)

Get process row Id from name

Parameters:

name - Name

Returns:

Process row Id

getProcessName

public static java.lang.String getProcessName(java.lang.String rowId)

Get process name from rowId

Parameters:

rowId - Row Id

Returns:

Process name

getCacheKey

public java.lang.String getCacheKey(Grant g)

Get process unique cache key

Specified by:

getCacheKey in interface CacheInterface

Parameters:

g - Grant

Returns:

Cache key of object instance

lastUsage

public long lastUsage(boolean update)

Last usage timestamp (last access to process engine)

Specified by:

lastUsage in interface CacheInterface

Parameters:

update - true to update the current time

Returns:

Last usage in millisecond (-1 no GC)

enableGC

public void enableGC(boolean enabled)

Enable or disable the internal GC

Specified by:

enableGC in interface CacheInterface

Parameters:

enabled - false to disable internal GC

garbageCollection

public boolean garbageCollection()

Garbage collection of dynamic data

Specified by:

garbageCollection in interface CacheInterface

Returns:

true if something has been cleared

getData

public ProcessusData getData()

Process dynamic data

Returns:

Process dynamic data

setData

public void setData(ProcessusData data)

getGrant

public Grant getGrant()

Get the rights of the process user

Returns:

rights of the process user

setGrant

public void setGrant(Grant g)

getPID

public java.lang.String getPID()

Get the process instance row id (bpm_process_file)

Returns:

process instance row id

setPID

public void setPID(java.lang.String pid)

getId

public java.lang.String getId()

Unique process definition id

Returns:

Unique process definition id

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

Process name

Returns:

Process name

setName

public void setName(java.lang.String name)

getType

public int getType()

Process type

Returns:

Process type

setType

public void setType(int type)

isMultiUsers

public boolean isMultiUsers()

isScreenFlow

public boolean isScreenFlow()

getShortName

public java.lang.String getShortName()

Process short name

Returns:

Process short name

setShortName

public void setShortName(java.lang.String name)

persistWhenTerminated

public boolean persistWhenTerminated()

Persist process in DB when terminated ?

Returns:

Persist process in DB when terminated ?

getPersistenceDepth

public int getPersistenceDepth()

setPersistenceWhenTerminated

public void setPersistenceWhenTerminated(boolean b,
                                         int depth)

getScriptId

public java.lang.String getScriptId()

Get server script document ID

Returns:

document ID

setScriptId

public void setScriptId(java.lang.String id)

Set server script document ID

Parameters:

id - document Id

readScript

public java.lang.String readScript(boolean force)

Read server script document content (read using getScriptId())

Parameters:

force - Force ?

Returns:

script document content

getSharedScripts

public java.util.List<Script> getSharedScripts()

Get all shared scripts

Returns:

all shared scripts

addSharedScript

public void addSharedScript(Script s)

Add a shared script

Parameters:

s - Script

getParentContext

public ActivityFile getParentContext()

Parent context in case of a sub-process

Returns:

Parent context

setParentContext

public void setParentContext(ActivityFile context)

getProcessParameter

public java.lang.Object getProcessParameter(java.lang.String name)

Get a process parameter

Parameters:

name - Parameter name

Returns:

Object or null if unknown

setProcessParameter

public void setProcessParameter(java.lang.String name,
                                java.lang.Object value)

Set a process parameter

Parameters:

name - Parameter name

value - Parameter

removeProcessParameter

public void removeProcessParameter(java.lang.String name)

Remove a process parameter

Parameters:

name - Parameter name

getPermissions

public java.util.Map<java.lang.String,java.lang.String> getPermissions()

Get all permissions by group:function where function = R, N or C

Returns:

all permissions by group:function

addPermission

public void addPermission(java.lang.String group,
                          char grant)

Add permission

Parameters:

group - Group name

grant - READ/NEW/CANCEL

delPermission

public void delPermission(java.lang.String group,
                          char grant)

Delete permission

Parameters:

group - Group name

grant - READ/NEW/CANCEL

isNewGranted

public boolean isNewGranted(java.lang.String group)

isNewGranted

public boolean isNewGranted(Grant g)

isReadGranted

public boolean isReadGranted(java.lang.String group)

isReadGranted

public boolean isReadGranted(Grant g)

isCancelGranted

public boolean isCancelGranted(java.lang.String group)

isCancelGranted

public boolean isCancelGranted(Grant g)

setDuration

public void setDuration(int max,
                        char unit)

Set the max duration of the process (then send the deadline alert)

Parameters:

max - Quantity

unit - Duration unit

getDeadline

public java.lang.String getDeadline(java.util.Date dt)

Get the process deadline

Parameters:

dt - Start date

Returns:

Date yyyy-MM-dd HH:mm:ss (start date + duration)

getAlert

public Alert getAlert()

Deadline alert, may be null

Returns:

Deadline alert

setAlert

public void setAlert(Alert a)

getCompensationProcess

public java.lang.String getCompensationProcess()

Compensation process

Returns:

Compensation process

setCompensationProcess

public void setCompensationProcess(java.lang.String name)

getDisplay

public java.lang.String getDisplay()

Process translation

Returns:

Process translation

setDisplay

public void setDisplay(java.lang.String d)

addActivity

public void addActivity(Activity a)

Add one activity to the process

Parameters:

a - Activity

getActivity

public Activity getActivity(java.lang.String step)

Get the activity of a given step

Parameters:

step - The activity step

Returns:

Activity definition

setMainActivityStep

public void setMainActivityStep(java.lang.String step)

Set the main activity of the process

Parameters:

step - Activity step

getMainActivity

public Activity getMainActivity()

Get he main activity if exists

Returns:

Activity definition

setMainObjectCascadeDelete

public void setMainObjectCascadeDelete(char del)

Set cascade deletion of business process when main object is deleted

Parameters:

del - ObjectDB.DEL*

getMainObjectCascadeDelete

public char getMainObjectCascadeDelete()

Get cascade deletion of business process when main object is deleted

Returns:

cascade deletion of business process when main object is deleted

getActivities

public java.util.List<Activity> getActivities()

Get all activities

Returns:

ArrayList of activities

getTransitions

public java.util.List<Transition> getTransitions()

Get all transitions

Returns:

ArrayList of transitions

getTransition

public Transition getTransition(java.lang.String name)

Get a transition

Parameters:

name - transition name (the transition must have a specified name)

Returns:

Transition

getBegin

public Activity getBegin()

Get the begin activity

Returns:

begin activity

getEnd

public Activity getEnd()

Get the end activity

Returns:

end activity

addTransition

public void addTransition(java.lang.String id,
                          java.lang.String name,
                          java.lang.String from,
                          java.lang.String to,
                          java.lang.String condition,
                          java.lang.String callback,
                          Alert alert,
                          Action action)

Add a transition between 2 activities

Parameters:

id - Transition id

name - Transition name

from - Origin step

to - Destination step

condition - Optional transition condition, null=no condition

callback - Optional Callback method during transition

alert - Optional Alert to send during transition

action - Optional Action button

getNext

public Transition getNext(java.lang.String step,
                          java.lang.String condition,
                          java.lang.String action,
                          java.lang.String nextStep)

Get the available transition with a given condition. If no route exists with this condition, the next activity is the transition with the [DEFAULT] condition

Parameters:

step - Activity step

condition - Optional Contextual value of condition

action - Optional Action name

nextStep - Optional Forced next step

Returns:

A transition or null if no route exists

getNext

public java.util.List<Transition> getNext(java.lang.String step)

Get all transition from a given step without any condition

Parameters:

step - Activity step

Returns:

ArrayList of transitions

getNextActions

public java.util.List<Transition> getNextActions(java.lang.String step)

Get all transitions with user Actions from a given step

Parameters:

step - Activity step

Returns:

ArrayList of transitions

getNextActions

public java.util.List<Transition> getNextActions(java.lang.String step,
                                                 boolean enabledOnly)

Get all transitions with user Actions from a given step

Parameters:

step - Activity step

enabledOnly - To ensure that action is enabled

Returns:

ArrayList of transitions

getPrevious

public java.util.List<Activity> getPrevious(java.lang.String step)

Get all previous activities from a step

Parameters:

step - Activity step

Returns:

ArrayList of activities

initProcessRoad

public void initProcessRoad()

getProcessRoad

public ProcessRoad getProcessRoad()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object