Package com.simplicite.bpm
Class Activity
- java.lang.Object
-
- com.simplicite.bpm.Activity
-
- All Implemented Interfaces:
java.io.Serializable
public class Activity extends java.lang.Object implements java.io.Serializable
Activity definition- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static char
DAY
Duration unit DAYstatic char
HOUR
Duration unit HOURstatic char
MINUTE
Duration unit MINUTEstatic char
MONTH
Duration unit MONTHstatic char
PERMISSION_CANCEL
Cancel right (cancel the task)static char
PERMISSION_READ
Read right (read the task)static char
PERMISSION_WRITE
Write right (make the task)static char
REVERS_ERASE
Return to the previous activity (with context deletion)static char
REVERS_NONE
No returnstatic char
REVERS_SIMPLE
Simple return to the previous activity (keeping context)static char
SECOND
Duration unit SECONDstatic char
TYPE_BEGIN
Begin activity (unique in a process)static char
TYPE_CONDITION
Switch case activitiesstatic char
TYPE_END
End activity (unique in a process)static char
TYPE_EXTERN
External activitystatic char
TYPE_FORM_DEL
Object deletestatic char
TYPE_FORM_NEW
Object creationstatic char
TYPE_FORM_UPD
Object updatestatic char
TYPE_JOIN
Join activities (background only)static char
TYPE_MESSAGE
Message activitystatic char
TYPE_MONO_SELECT
Object selectionstatic char
TYPE_MULTI_SELECT
Object mulit-selectionstatic char
TYPE_SEARCH
Object searchstatic char
TYPE_SERVICE
Object service (background only)static char
TYPE_SPLIT
Split activities (background only)static char
TYPE_SUBPROCESS
Sub-process activitystatic char
YEAR
Duration unit YEAR
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addData(Data d)
Add a data to the activityvoid
addPermission(java.lang.String group, char grant)
Add permissionjava.util.Map<java.lang.String,java.util.List<Data>>
data()
Get activity datavoid
delPermission(java.lang.String group, char grant)
Delete permissionAlert
getAlert()
Get deadline alertjava.util.Iterator<Data>
getData()
Get iterator on activity dataData
getData(java.lang.String group, java.lang.String name)
Get activity datajava.lang.String
getDeadline(java.util.Date dt)
Get the activity deadlinejava.lang.String
getDisplay()
Get activity translationlong
getDuration()
Activity durationjava.lang.String
getHelp()
Get activity long helpjava.lang.String
getId()
Get unique IDjava.lang.String
getLabel()
Activity translation (alias to getDisplay)java.lang.String
getMiniHelp()
Get activity short helpjava.lang.String
getModuleId()
Get module IDjava.lang.String
getName()
Get activity nameProcessus
getProcessus()
Get the process definitionchar
getReversible()
Reversibility mode to return to the previous activityjava.lang.String
getStep()
Get step name (the short name of activity that will be used by the system)java.lang.String
getTemplate()
Get templatechar
getType()
Get activity type (BEGIN, END...)java.lang.String
getUITemplate()
Get UI templateboolean
isCancelGranted(Grant g)
Is cancel granted?boolean
isCancelGranted(java.lang.String group)
Is cancel granted?boolean
isReadGranted(Grant g)
Is read granted?boolean
isReadGranted(java.lang.String group)
Is read granted?boolean
isReversible()
Is the activity can return to the previous activity?boolean
isUserDialog()
Is the activity a user dialogboolean
isWriteGranted(Grant g)
Is write granted?boolean
isWriteGranted(java.lang.String group)
Is write granted?void
setAlert(Alert alert)
Set deadline alertvoid
setDisplay(java.lang.String d)
Set activity translationvoid
setDuration(int max, char unit)
Set the max duration of the activity (then send the deadline alert)void
setHelp(java.lang.String help)
Set activity long helpvoid
setId(java.lang.String id)
Set unique IDvoid
setModuleId(java.lang.String id)
Set module IDvoid
setShortHelp(java.lang.String shorthelp)
Set activity short helpvoid
setTemplate(java.lang.String template)
Set templatevoid
setType(char type)
Set activity typevoid
setUITemplate(java.lang.String template)
Set UI templatevoid
setUserDialog(boolean b)
Set whether the activity is a user dialogorg.json.JSONObject
toJSONObject()
Generates a JSON object representation of the activityjava.lang.String
toString()
Generates a string representation of the activityboolean
userDialog()
Deprecated.Use isUserDialog
-
-
-
Field Detail
-
TYPE_BEGIN
public static final char TYPE_BEGIN
Begin activity (unique in a process)- See Also:
- Constant Field Values
-
TYPE_END
public static final char TYPE_END
End activity (unique in a process)- See Also:
- Constant Field Values
-
TYPE_SEARCH
public static final char TYPE_SEARCH
Object search- See Also:
- Constant Field Values
-
TYPE_FORM_NEW
public static final char TYPE_FORM_NEW
Object creation- See Also:
- Constant Field Values
-
TYPE_FORM_UPD
public static final char TYPE_FORM_UPD
Object update- See Also:
- Constant Field Values
-
TYPE_FORM_DEL
public static final char TYPE_FORM_DEL
Object delete- See Also:
- Constant Field Values
-
TYPE_SERVICE
public static final char TYPE_SERVICE
Object service (background only)- See Also:
- Constant Field Values
-
TYPE_MONO_SELECT
public static final char TYPE_MONO_SELECT
Object selection- See Also:
- Constant Field Values
-
TYPE_MULTI_SELECT
public static final char TYPE_MULTI_SELECT
Object mulit-selection- See Also:
- Constant Field Values
-
TYPE_SPLIT
public static final char TYPE_SPLIT
Split activities (background only)- See Also:
- Constant Field Values
-
TYPE_JOIN
public static final char TYPE_JOIN
Join activities (background only)- See Also:
- Constant Field Values
-
TYPE_CONDITION
public static final char TYPE_CONDITION
Switch case activities- See Also:
- Constant Field Values
-
TYPE_EXTERN
public static final char TYPE_EXTERN
External activity- See Also:
- Constant Field Values
-
TYPE_MESSAGE
public static final char TYPE_MESSAGE
Message activity- See Also:
- Constant Field Values
-
TYPE_SUBPROCESS
public static final char TYPE_SUBPROCESS
Sub-process activity- See Also:
- Constant Field Values
-
REVERS_NONE
public static final char REVERS_NONE
No return- See Also:
- Constant Field Values
-
REVERS_SIMPLE
public static final char REVERS_SIMPLE
Simple return to the previous activity (keeping context)- See Also:
- Constant Field Values
-
REVERS_ERASE
public static final char REVERS_ERASE
Return to the previous activity (with context deletion)- See Also:
- Constant Field Values
-
YEAR
public static final char YEAR
Duration unit YEAR- See Also:
- Constant Field Values
-
MONTH
public static final char MONTH
Duration unit MONTH- See Also:
- Constant Field Values
-
DAY
public static final char DAY
Duration unit DAY- See Also:
- Constant Field Values
-
HOUR
public static final char HOUR
Duration unit HOUR- See Also:
- Constant Field Values
-
MINUTE
public static final char MINUTE
Duration unit MINUTE- See Also:
- Constant Field Values
-
SECOND
public static final char SECOND
Duration unit SECOND- See Also:
- Constant Field Values
-
PERMISSION_READ
public static final char PERMISSION_READ
Read right (read the task)- See Also:
- Constant Field Values
-
PERMISSION_WRITE
public static final char PERMISSION_WRITE
Write right (make the task)- See Also:
- Constant Field Values
-
PERMISSION_CANCEL
public static final char PERMISSION_CANCEL
Cancel right (cancel the task)- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Activity
public Activity(Processus p, java.lang.String id, java.lang.String step, java.lang.String name, char type, boolean userDialog, char revers, java.lang.String moduleId)
Constructor- Parameters:
p
- Processusid
- IDstep
- Stepname
- Nametype
- TypeuserDialog
- With user dialog?revers
- Reversibility modemoduleId
- Module ID
-
-
Method Detail
-
getId
public java.lang.String getId()
Get unique ID- Returns:
- Unique ID
-
setId
public void setId(java.lang.String id)
Set unique ID- Parameters:
id
- Unique ID
-
getModuleId
public java.lang.String getModuleId()
Get module ID- Returns:
- Module ID
-
setModuleId
public void setModuleId(java.lang.String id)
Set module ID- Parameters:
id
- Module ID
-
getProcessus
public Processus getProcessus()
Get the process definition- Returns:
- Processus definition
-
getStep
public java.lang.String getStep()
Get step name (the short name of activity that will be used by the system)- Returns:
- Step name
-
getName
public java.lang.String getName()
Get activity name- Returns:
- Activity name
-
setDisplay
public void setDisplay(java.lang.String d)
Set activity translation- Parameters:
d
- Activity translation
-
getDisplay
public java.lang.String getDisplay()
Get activity translation- Returns:
- Activity translation
-
getLabel
public java.lang.String getLabel()
Activity translation (alias to getDisplay)- Returns:
- Text
-
setShortHelp
public void setShortHelp(java.lang.String shorthelp)
Set activity short help- Parameters:
shorthelp
- Short help
-
getMiniHelp
public java.lang.String getMiniHelp()
Get activity short help- Returns:
- Short help
-
setHelp
public void setHelp(java.lang.String help)
Set activity long help- Parameters:
help
- Long help
-
getHelp
public java.lang.String getHelp()
Get activity long help- Returns:
- Long help
-
getType
public char getType()
Get activity type (BEGIN, END...)- Returns:
- Activity type
-
setType
public void setType(char type)
Set activity type- Parameters:
type
- Activity type
-
userDialog
@Deprecated public boolean userDialog()
Deprecated.Use isUserDialog
-
isUserDialog
public boolean isUserDialog()
Is the activity a user dialog- Returns:
- True if the activity needs a user dialog
-
setUserDialog
public void setUserDialog(boolean b)
Set whether the activity is a user dialog- Parameters:
b
- User dialog?
-
getReversible
public char getReversible()
Reversibility mode to return to the previous activity- Returns:
- One of REVERS_*
-
isReversible
public boolean isReversible()
Is the activity can return to the previous activity?- Returns:
- true if activity is reversible (other mode than REVERS_NONE)
-
setDuration
public void setDuration(int max, char unit)
Set the max duration of the activity (then send the deadline alert)- Parameters:
max
- Quantityunit
- Duration unit
-
getDeadline
public java.lang.String getDeadline(java.util.Date dt)
Get the activity deadline- Parameters:
dt
- Start date- Returns:
- Date yyyy-MM-dd HH:mm:ss (start date + duration)
-
getDuration
public long getDuration()
Activity duration- Returns:
- Activity duration
-
getAlert
public Alert getAlert()
Get deadline alert- Returns:
- Deadline alert
-
setAlert
public void setAlert(Alert alert)
Set deadline alert- Parameters:
alert
- Deadline alert
-
data
public java.util.Map<java.lang.String,java.util.List<Data>> data()
Get activity data- Returns:
- Activity data
-
getData
public java.util.Iterator<Data> getData()
Get iterator on activity data- Returns:
- All activity data
-
getData
public Data getData(java.lang.String group, java.lang.String name)
Get activity data- Parameters:
group
- Group name of dataname
- Data name- Returns:
- data definition
-
addData
public void addData(Data d)
Add a data to the activity- Parameters:
d
- data definition
-
addPermission
public void addPermission(java.lang.String group, char grant)
Add permission- Parameters:
group
- Groupgrant
- Grant type
-
delPermission
public void delPermission(java.lang.String group, char grant)
Delete permission- Parameters:
group
- Groupgrant
- Grant type
-
isWriteGranted
public boolean isWriteGranted(java.lang.String group)
Is write granted?- Parameters:
group
- Group- Returns:
- True if write is granted
-
isWriteGranted
public boolean isWriteGranted(Grant g)
Is write granted?- Parameters:
g
- Grant- Returns:
- True if write is granted
-
isReadGranted
public boolean isReadGranted(java.lang.String group)
Is read granted?- Parameters:
group
- Group- Returns:
- True if read is granted
-
isReadGranted
public boolean isReadGranted(Grant g)
Is read granted?- Parameters:
g
- Grant- Returns:
- True if read is granted
-
isCancelGranted
public boolean isCancelGranted(java.lang.String group)
Is cancel granted?- Parameters:
group
- Group- Returns:
- True if cancel is granted
-
isCancelGranted
public boolean isCancelGranted(Grant g)
Is cancel granted?- Parameters:
g
- Grant- Returns:
- True if cancel is granted
-
setTemplate
public void setTemplate(java.lang.String template)
Set template- Parameters:
template
- Template
-
getTemplate
public java.lang.String getTemplate()
Get template- Returns:
- Template
-
setUITemplate
public void setUITemplate(java.lang.String template)
Set UI template- Parameters:
template
- UI template
-
getUITemplate
public java.lang.String getUITemplate()
Get UI template- Returns:
- UI template
-
toJSONObject
public org.json.JSONObject toJSONObject()
Generates a JSON object representation of the activity- Returns:
- Activity as JSON object
-
toString
public java.lang.String toString()
Generates a string representation of the activity- Overrides:
toString
in classjava.lang.Object
- Returns:
- activity as string
-
-