Package com.simplicite.bpm
Class ActivityFile
- java.lang.Object
-
- com.simplicite.bpm.ActivityFile
-
- All Implemented Interfaces:
java.io.Serializable
public class ActivityFile extends java.lang.Object implements java.io.Serializable
Activity file for storing instantiated process data
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static char
STATE_CANCELED
static char
STATE_DONE
static char
STATE_PLANNED
static char
STATE_RUNNING
static char
STATE_WAITING
-
Constructor Summary
Constructors Constructor Description ActivityFile(Activity a, java.lang.String aid)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataFile
addDataFile(Data d)
Add dataDataFile
addDataFile(java.lang.String group, java.lang.String name)
Add dynamic dataDataFile
addDataFile(java.lang.String group, java.lang.String name, java.lang.String value)
Add dynamic data with a valuejava.util.Map<java.lang.String,java.util.List<DataFile>>
dataFiles()
Activity
getActivity()
java.lang.String
getAID()
Instance number of activityDataFile
getDataFile(java.lang.String group, java.lang.String name, boolean traceMissing)
Retrieve context data from its pathjava.util.List<DataFile>
getDataFiles()
Retrieve all context datajava.util.List<DataFile>
getDataFiles(java.lang.String group)
Retrieve context data for a groupjava.lang.String
getDataValue(java.lang.String group, java.lang.String name)
Retrieve context (first) value from its pathjava.io.InputStream
getDataValueContent(java.lang.String group, java.lang.String name, boolean deleteOnClose)
Retrieve context file content part from its pathjava.lang.String
getDataValueName(java.lang.String group, java.lang.String name)
Retrieve context file name part from its pathjava.lang.String
getDeadline()
Planned end datejava.lang.String
getEndDate()
Actual end datejava.lang.String
getExternalURL()
Prepare URL of external activity (Page.Name)java.lang.String
getOwnerId()
Owner is a user id, may be null if nobody uses the activityjava.lang.String
getPID()
Instance number of processjava.lang.String
getPlanDate()
Planned start dateProcessus
getProcessus()
Business processjava.lang.String
getStartDate()
Actual start datechar
getStatus()
State STATE_*java.lang.Long
getWaitingTime()
Waiting time in seconds from the previous activity (long process only)boolean
isReadOnly()
Is read onlyjava.util.List<ObjectFieldSearch>
loadFilters(ObjectDB obj, Processus p)
java.lang.String
parseTemplate(java.lang.String templateTag)
Complete with parsed values, common tokens...void
removeDataFile(java.lang.String group, java.lang.String name)
Remove dynamic datavoid
setAID(java.lang.String aid)
void
setDataFile(java.lang.String group, java.lang.String name, java.lang.String value)
Update mono value context datavoid
setDataFile(java.lang.String group, java.lang.String name, java.lang.String[] values)
Update multi values context data.void
setDataFile(java.lang.String group, java.lang.String name, java.lang.String path, byte[] data)
Update binary context datavoid
setDataFile(java.lang.String group, java.lang.String name, java.lang.String path, java.io.File file)
Update file context datavoid
setDataFile(java.lang.String group, java.lang.String name, java.util.List<java.lang.String> values)
Update multi-values context datavoid
setDeadline(java.lang.String d)
void
setEndDate(java.lang.String d)
void
setNextStep(java.lang.String nextStep)
Force the next stepvoid
setOwnerId(int userId)
void
setOwnerId(java.lang.String userId)
void
setPID(java.lang.String id)
void
setPlanDate(java.lang.String d)
void
setReadOnly(boolean b)
void
setStartDate(java.lang.String d)
void
setStartDate(java.lang.String d, boolean waitingTime)
void
setStatus(char s)
void
setWaitingTime(java.lang.Long wt)
java.lang.String
toJSON()
java.lang.String
toJSON(ObjectDB obj, boolean metadata)
org.json.JSONObject
toJSONObject()
Generates a JSON object representation of the activity filejava.lang.String
toString()
Generates a string representation of the activity file
-
-
-
Field Detail
-
STATE_PLANNED
public static final char STATE_PLANNED
- See Also:
- Constant Field Values
-
STATE_WAITING
public static final char STATE_WAITING
- 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
-
-
Constructor Detail
-
ActivityFile
public ActivityFile(Activity a, java.lang.String aid)
-
-
Method Detail
-
getActivity
public Activity getActivity()
-
getProcessus
public Processus getProcessus()
Business process- Returns:
- Processus
-
getAID
public java.lang.String getAID()
Instance number of activity- Returns:
- AID
-
setAID
public void setAID(java.lang.String aid)
-
getPID
public java.lang.String getPID()
Instance number of process- Returns:
- PID
-
setPID
public void setPID(java.lang.String id)
-
isReadOnly
public boolean isReadOnly()
Is read only- Returns:
- Is read only ?
-
setReadOnly
public void setReadOnly(boolean b)
-
getStatus
public char getStatus()
State STATE_*- Returns:
- Status
-
setStatus
public void setStatus(char s)
-
getOwnerId
public java.lang.String getOwnerId()
Owner is a user id, may be null if nobody uses the activity- Returns:
- Owner
-
setOwnerId
public void setOwnerId(int userId)
-
setOwnerId
public void setOwnerId(java.lang.String userId)
-
getPlanDate
public java.lang.String getPlanDate()
Planned start date- Returns:
- Planned start date
-
setPlanDate
public void setPlanDate(java.lang.String d)
-
getDeadline
public java.lang.String getDeadline()
Planned end date- Returns:
- Deadline
-
setDeadline
public void setDeadline(java.lang.String d)
-
getStartDate
public java.lang.String getStartDate()
Actual start date- Returns:
- Start Date
-
setStartDate
public void setStartDate(java.lang.String d)
-
setStartDate
public void setStartDate(java.lang.String d, boolean waitingTime)
-
getWaitingTime
public java.lang.Long getWaitingTime()
Waiting time in seconds from the previous activity (long process only)- Returns:
- Waiting Time
-
setWaitingTime
public void setWaitingTime(java.lang.Long wt)
-
getEndDate
public java.lang.String getEndDate()
Actual end date- Returns:
- End Date
-
setEndDate
public void setEndDate(java.lang.String d)
-
addDataFile
public DataFile addDataFile(java.lang.String group, java.lang.String name)
Add dynamic data- Parameters:
group
- Groupname
- Name- Returns:
- DataFile
-
addDataFile
public DataFile addDataFile(java.lang.String group, java.lang.String name, java.lang.String value)
Add dynamic data with a value- Parameters:
group
- Groupname
- Namevalue
- Value- Returns:
- DataFile
-
removeDataFile
public void removeDataFile(java.lang.String group, java.lang.String name)
Remove dynamic data- Parameters:
group
- Groupname
- Name
-
getDataFile
public DataFile getDataFile(java.lang.String group, java.lang.String name, boolean traceMissing)
Retrieve context data from its path- Parameters:
group
- Groupname
- NametraceMissing
- traceMissing ?- Returns:
- context data
-
getDataValue
public java.lang.String getDataValue(java.lang.String group, java.lang.String name)
Retrieve context (first) value from its path- Parameters:
group
- Groupname
- Name- Returns:
- context value
-
getDataValueName
public java.lang.String getDataValueName(java.lang.String group, java.lang.String name)
Retrieve context file name part from its path- Parameters:
group
- Groupname
- Name- Returns:
- file name
-
getDataValueContent
public java.io.InputStream getDataValueContent(java.lang.String group, java.lang.String name, boolean deleteOnClose)
Retrieve context file content part from its path- Parameters:
group
- Group of dataname
- Data namedeleteOnClose
- delete file after reading?- Returns:
- data stream
-
getDataFiles
public java.util.List<DataFile> getDataFiles(java.lang.String group)
Retrieve context data for a group- Parameters:
group
- Group- Returns:
- List of DataFile
-
getDataFiles
public java.util.List<DataFile> getDataFiles()
Retrieve all context data- Returns:
- List of DataFile
-
dataFiles
public java.util.Map<java.lang.String,java.util.List<DataFile>> dataFiles()
-
setDataFile
public void setDataFile(java.lang.String group, java.lang.String name, java.lang.String value)
Update mono value context data- Parameters:
group
- Groupname
- Namevalue
- Value
-
setDataFile
public void setDataFile(java.lang.String group, java.lang.String name, java.lang.String path, byte[] data)
Update binary context data- Parameters:
group
- Groupname
- Namepath
- Pathdata
- Data
-
setDataFile
public void setDataFile(java.lang.String group, java.lang.String name, java.lang.String path, java.io.File file)
Update file context data- Parameters:
group
- Groupname
- Namepath
- Pathfile
- File
-
setDataFile
public void setDataFile(java.lang.String group, java.lang.String name, java.util.List<java.lang.String> values)
Update multi-values context data- Parameters:
group
- Groupname
- Namevalues
- Values
-
setDataFile
public void setDataFile(java.lang.String group, java.lang.String name, java.lang.String[] values)
Update multi values context data.- Parameters:
group
- Groupname
- Namevalues
- Values
-
setNextStep
public void setNextStep(java.lang.String nextStep)
Force the next step- Parameters:
nextStep
- Next step name
-
loadFilters
public java.util.List<ObjectFieldSearch> loadFilters(ObjectDB obj, Processus p)
-
parseTemplate
public java.lang.String parseTemplate(java.lang.String templateTag)
Complete with parsed values, common tokens...- Parameters:
templateTag
- Template tag
-
getExternalURL
public java.lang.String getExternalURL()
Prepare URL of external activity (Page.Name)
-
toJSON
public java.lang.String toJSON()
-
toJSON
public java.lang.String toJSON(ObjectDB obj, boolean metadata)
-
toJSONObject
public org.json.JSONObject toJSONObject()
Generates a JSON object representation of the activity file- Returns:
- activity file as JSON object
-
toString
public java.lang.String toString()
Generates a string representation of the activity file- Overrides:
toString
in classjava.lang.Object
- Returns:
- activity file as string
-
-