public class Processus extends ProcessusCore
Business process
CANCEL, NEW, READ, STATE_CANCELED, STATE_DONE, STATE_RUNNING, STATE_STARTED, TYPE_ACTIVITY, TYPE_GUI, TYPE_SCREENFLOW, UNIT_DAY, UNIT_HOUR, UNIT_MINUTE, UNIT_MONTH, UNIT_SECOND, UNIT_YEAR
Modifier and Type | Method and Description |
---|---|
Message |
abandon()
Abandon the process before the end
|
Message |
activate()
Activate a process and return the first user activity
|
DataFile |
addDynamicData(ActivityFile context,
java.lang.String name,
java.lang.String def)
Add dynamically a Data to the activity (useful in external activity)
|
DataFile |
addDynamicData(ActivityFile context,
java.lang.String group,
java.lang.String name,
java.lang.String def,
java.lang.String value)
Add dynamically a Data to the activity (useful in external activity)
|
void |
backward(ActivityFile context,
ActivityFile back)
Hook called on a backward event of a user activity
|
Message |
cancel(Activity a,
java.lang.String aid)
Cancel/Skip a user activity (status CANCEL)
|
int[] |
getCacheInfo()
Get cache info: current and max size of processes
|
ActivityFile |
getContext(Activity a)
Load the activity context
|
ActivityFile |
getContext(Activity a,
java.lang.String aid)
Load the activity context
|
ActivityFile |
getCurrentActivity()
Return the current activity of a screenflow.
|
java.lang.String |
getMainObject(ActivityFile context)
Return the main object of the business process.
|
java.lang.String |
getParameter(Activity a,
java.lang.String group,
java.lang.String name)
Read a contextual data in activity
|
java.util.Vector<java.lang.String> |
getParameter(Activity a,
java.lang.String index,
java.lang.String group,
java.lang.String name)
Read a contextual data in activity
|
java.util.Vector<java.lang.String> |
getParameter(java.lang.String road)
Read a contextual data in the process
|
ActivityFile |
getPreviousContext(ActivityFile context)
Return the previous activity
|
void |
init(Grant g)
Hook after definition loading
|
void |
instantiate()
New process instance
|
void |
invokeCallback(ActivityFile context,
java.lang.String callbackName)
Simple callback method call
|
java.lang.String |
invokePageMethod(ActivityFile context,
java.lang.Object ctx,
java.lang.String method) |
java.lang.String |
invokeServiceMethod(ActivityFile context,
java.lang.String method,
java.util.Vector<?> params) |
boolean |
isUndoable()
Hook to allow undo/redo the full process
|
Alert |
loadAlert(int type,
java.lang.String name,
ObjectDB obj)
Load the alert definition
|
Alert |
loadAlert(java.lang.String id,
int type,
ObjectDB obj)
Load the alert definition
|
Message |
lock(Activity a,
java.lang.String aid)
Lock foreground (user dialog) activity (status RUNNING).
|
java.lang.String |
parseValue(ActivityFile context,
java.lang.String value)
Parse a value with replacement of tokens under brackets :
[login], [lang], [now], [text:code], [step.index.group.data]
|
void |
postAbandon()
Hook called after a process abandon (useful for specific cleaning)
|
void |
postActivate()
Hook called after activation
|
void |
postCancel(ActivityFile context)
Hook called after activity canceling/skipping
|
void |
postInstantiate(Grant g)
Hook called when one process is instantiated
|
void |
postLock(ActivityFile context)
Hook called after the lock of a foreground activity (user dialog)
|
void |
postTerminate()
Hook called after termination of process
|
void |
postUnlock(ActivityFile context)
Hook called after the unlock of a foreground activity (user dialog)
|
void |
postValidate(ActivityFile context)
Hook called when the activity has been validated (useful to add specific controls)
|
Message |
preAbandon()
Hook called before a process abandon
|
Message |
preActivate()
Hook called before activation
|
Message |
preCancel(ActivityFile context)
Hook called before activity canceling/skipping
|
Message |
preLock(ActivityFile context)
Hook called before the lock of a foreground activity (user dialog)
|
Message |
preTerminate()
Hook called before termination of process
|
Message |
preUnlock(ActivityFile context)
Hook called before the unlock of a foreground activity (user dialog)
|
Message |
preValidate(ActivityFile context)
Hook called before activity validation (useful to change/complete data)
|
void |
storeContext(ActivityFile context)
Store the activity context (in session for a screenflow, or in DB for a persistent workflow)
|
Message |
terminate()
Terminate the process (automatically called at the END of process)
|
Message |
unlock(Activity a,
java.lang.String aid)
Unlock foreground (user dialog) activity (status WAITING).
|
Message |
validate(ActivityFile context)
Hook called when the activity must be manually validated
|
Message |
validate(ActivityFile context,
ObjectDB obj)
Common activity validation
|
addActivity, addPermission, addSharedScript, addTransition, delPermission, enableGC, garbageCollection, getActivities, getActivity, getAlert, getBegin, getCacheKey, getCompensationProcess, getData, getDeadline, getDisplay, getEnd, getGrant, getId, getMainActivity, getMainObjectCascadeDelete, getName, getNext, getNext, getNextActions, getNextActions, getParentContext, getPermissions, getPersistenceDepth, getPID, getPrevious, getProcessParameter, getProcessRoad, getScriptId, getSharedScripts, getShortName, getTransition, getTransitions, getType, initProcessRoad, isCancelGranted, isCancelGranted, isMultiUsers, isNewGranted, isNewGranted, isReadGranted, isReadGranted, isScreenFlow, lastUsage, persistWhenTerminated, readScript, removeProcessParameter, setAlert, setCompensationProcess, setData, setDisplay, setDuration, setGrant, setId, setMainActivityStep, setMainObjectCascadeDelete, setName, setParentContext, setPersistenceWhenTerminated, setPID, setProcessParameter, setScriptId, setShortName, setType, toString
public Processus()
public Processus(Grant g)
public int[] getCacheInfo()
Get cache info: current and max size of processes
public void init(Grant g)
public void instantiate()
public void postInstantiate(Grant g)
g
- User rightspublic Alert loadAlert(int type, java.lang.String name, ObjectDB obj)
type
- info or warningname
- Alert nameobj
- Business object (with a state model)public Alert loadAlert(java.lang.String id, int type, ObjectDB obj)
id
- alert idtype
- info or warningobj
- Business object (with a state model)public boolean isUndoable()
Hook to allow undo/redo the full process
public Message activate()
public Message preActivate()
public void postActivate()
public Message terminate()
public Message preTerminate()
public void postTerminate()
public Message abandon()
public Message preAbandon()
public void postAbandon()
public Message lock(Activity a, java.lang.String aid)
a
- Activityaid
- Activity file row idpublic Message preLock(ActivityFile context)
context
- The activity contextpublic void postLock(ActivityFile context)
context
- The activity contextpublic Message unlock(Activity a, java.lang.String aid)
a
- Activityaid
- Activity file row idpublic Message preUnlock(ActivityFile context)
context
- The activity contextpublic void postUnlock(ActivityFile context)
context
- The activity contextpublic void backward(ActivityFile context, ActivityFile back)
context
- The current activity contextback
- The backward activity contextpublic Message validate(ActivityFile context, ObjectDB obj)
context
- Activity contextobj
- Optional object (Search and CRUD activities based on a business object)public Message validate(ActivityFile context) throws java.lang.Exception
context
- The activity contextjava.lang.Exception
public Message preValidate(ActivityFile context)
context
- The activity contextpublic void postValidate(ActivityFile context)
context
- The activity contextpublic Message cancel(Activity a, java.lang.String aid)
a
- Activityaid
- Activity file row idpublic Message preCancel(ActivityFile context)
context
- The activity contextpublic void postCancel(ActivityFile context)
context
- The activity contextpublic ActivityFile getPreviousContext(ActivityFile context)
context
- Current activity contextpublic ActivityFile getContext(Activity a, java.lang.String aid)
a
- Activityaid
- Activity file row id (or null in a screenflow)public final ActivityFile getContext(Activity a)
a
- Activitypublic void storeContext(ActivityFile context)
context
- Activity contextpublic java.util.Vector<java.lang.String> getParameter(java.lang.String road)
road
- Road of data under brackets [stepname(.stepindex).groupname.dataname].
ex: [MyStep.Field.row_id], [MyStep.Field.MyRefId.MyField], [MyStep.Last.Filter.MyField]public java.util.Vector<java.lang.String> getParameter(Activity a, java.lang.String index, java.lang.String group, java.lang.String name)
a
- Activityindex
- First, Last, All, or nullgroup
- Group of dataname
- Parameter namepublic java.lang.String getParameter(Activity a, java.lang.String group, java.lang.String name)
a
- Activitygroup
- Group of dataname
- Parameter namepublic java.lang.String parseValue(ActivityFile context, java.lang.String value)
context
- Activity contextvalue
- The text to parsepublic ActivityFile getCurrentActivity()
public DataFile addDynamicData(ActivityFile context, java.lang.String name, java.lang.String def)
context
- Activity contextname
- Data name in group Datadef
- Static valuepublic DataFile addDynamicData(ActivityFile context, java.lang.String group, java.lang.String name, java.lang.String def, java.lang.String value)
context
- Activity contextgroup
- Data group namename
- Data namedef
- Static valuevalue
- Valuepublic void invokeCallback(ActivityFile context, java.lang.String callbackName) throws com.simplicite.util.exceptions.MethodException
Simple callback method call
callbackName
- Callback namecom.simplicite.util.exceptions.MethodException
public java.lang.String invokePageMethod(ActivityFile context, java.lang.Object ctx, java.lang.String method) throws com.simplicite.util.exceptions.MethodException
com.simplicite.util.exceptions.MethodException
public java.lang.String invokeServiceMethod(ActivityFile context, java.lang.String method, java.util.Vector<?> params) throws com.simplicite.util.exceptions.MethodException
com.simplicite.util.exceptions.MethodException
public java.lang.String getMainObject(ActivityFile context)
context
- Activity contextCopyright (c)2006-2014 Simplicite Software. All Rights Reserved.