public class ProcessusCore extends java.lang.Object implements java.io.Serializable, CacheInterface
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 and Description |
---|
ProcessusCore() |
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.Vector<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.Vector<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.Vector<Transition> |
getNextActions(java.lang.String step)
Get all transitions with user Actions from a given step
|
java.util.Vector<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.Hashtable<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.Vector<Activity> |
getPrevious(java.lang.String step)
Get all previous activities from a step
|
java.lang.Object |
getProcessParameter(java.lang.String name)
Get a process parameter
|
ProcessRoad |
getProcessRoad() |
java.lang.String |
getScriptId()
Set server script document ID
|
java.util.Vector<Script> |
getSharedScripts()
Get all shared scripts
|
java.lang.String |
getShortName()
Process short name
|
Transition |
getTransition(java.lang.String name)
Get a transition
|
java.util.Vector<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)
Get server script document ID
|
void |
setShortName(java.lang.String name) |
void |
setType(int type) |
java.lang.String |
toString() |
public static final char STATE_STARTED
public static final char STATE_RUNNING
public static final char STATE_DONE
public static final char STATE_CANCELED
public static final int TYPE_SCREENFLOW
@Deprecated public static final int TYPE_GUI
public static final int TYPE_ACTIVITY
public static final char READ
public static final char NEW
public static final char CANCEL
public static final char UNIT_YEAR
public static final char UNIT_MONTH
public static final char UNIT_DAY
public static final char UNIT_HOUR
public static final char UNIT_MINUTE
public static final char UNIT_SECOND
public java.lang.String getCacheKey(Grant g)
getCacheKey
in interface CacheInterface
public long lastUsage(boolean update)
lastUsage
in interface CacheInterface
update
- true to update the current timepublic void enableGC(boolean enabled)
enableGC
in interface CacheInterface
enabled
- false to disable internal GCpublic boolean garbageCollection()
garbageCollection
in interface CacheInterface
public ProcessusData getData()
public void setData(ProcessusData data)
public Grant getGrant()
public void setGrant(Grant g)
public java.lang.String getPID()
public void setPID(java.lang.String pid)
public java.lang.String getId()
public void setId(java.lang.String id)
public java.lang.String getName()
public void setName(java.lang.String name)
public int getType()
public void setType(int type)
public boolean isMultiUsers()
public boolean isScreenFlow()
public java.lang.String getShortName()
public void setShortName(java.lang.String name)
public boolean persistWhenTerminated()
public int getPersistenceDepth()
public void setPersistenceWhenTerminated(boolean b, int depth)
public java.lang.String getScriptId()
public void setScriptId(java.lang.String id)
public java.lang.String readScript(boolean force)
public java.util.Vector<Script> getSharedScripts()
public void addSharedScript(Script s)
public ActivityFile getParentContext()
public void setParentContext(ActivityFile context)
public java.lang.Object getProcessParameter(java.lang.String name)
name
- Parameter namepublic void setProcessParameter(java.lang.String name, java.lang.Object value)
name
- Parameter namevalue
- Parameterpublic void removeProcessParameter(java.lang.String name)
name
- Parameter namepublic java.util.Hashtable<java.lang.String,java.lang.String> getPermissions()
public void addPermission(java.lang.String group, char grant)
group
- Group namegrant
- READ/NEW/CANCELpublic void delPermission(java.lang.String group, char grant)
group
- Group namegrant
- READ/NEW/CANCELpublic boolean isNewGranted(java.lang.String group)
public boolean isNewGranted(Grant g)
public boolean isReadGranted(java.lang.String group)
public boolean isReadGranted(Grant g)
public boolean isCancelGranted(java.lang.String group)
public boolean isCancelGranted(Grant g)
public void setDuration(int max, char unit)
max
- Quantityunit
- Duration unitpublic java.lang.String getDeadline(java.util.Date dt)
dt
- Start datepublic Alert getAlert()
public void setAlert(Alert a)
public java.lang.String getCompensationProcess()
public void setCompensationProcess(java.lang.String name)
public java.lang.String getDisplay()
public void setDisplay(java.lang.String d)
public void addActivity(Activity a)
a
- Activitypublic Activity getActivity(java.lang.String step)
step
- The activity steppublic void setMainActivityStep(java.lang.String step)
step
- Activity steppublic Activity getMainActivity()
public void setMainObjectCascadeDelete(char del)
del
- ObjectDB.DEL*public char getMainObjectCascadeDelete()
public java.util.Vector<Activity> getActivities()
public java.util.Vector<Transition> getTransitions()
public Transition getTransition(java.lang.String name)
name
- transition name (the transition must have a specified name)public Activity getBegin()
public Activity getEnd()
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)
id
- Transition idname
- Transition namefrom
- Origin stepto
- Destination stepcondition
- Optional transition condition, null=no conditioncallback
- Optional Callback method during transitionalert
- Optional Alert to send during transitionaction
- Optional Action buttonpublic Transition getNext(java.lang.String step, java.lang.String condition, java.lang.String action, java.lang.String nextStep)
step
- Activity stepcondition
- Optional Contextual value of conditionaction
- Optional Action namenextStep
- Optional Forced next steppublic java.util.Vector<Transition> getNext(java.lang.String step)
step
- Activity steppublic java.util.Vector<Transition> getNextActions(java.lang.String step)
step
- Activity steppublic java.util.Vector<Transition> getNextActions(java.lang.String step, boolean enabledOnly)
step
- Activity stepenabledOnly
- To ensure that action is enabledpublic java.util.Vector<Activity> getPrevious(java.lang.String step)
step
- Activity steppublic void initProcessRoad()
public ProcessRoad getProcessRoad()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.