Package org.bonitasoft.web.client.model
Class Activity
- java.lang.Object
-
- org.bonitasoft.web.client.model.Activity
-
- All Implemented Interfaces:
Serializable
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class Activity extends Object implements Serializable
Use this resource to retrieve activities (human or service tasks), call activities, and subprocesses currently running on the platform. It enables you to perform maintenance tasks like skipping or replaying a failed task and modifying variables.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACTOR_IDstatic StringJSON_PROPERTY_ASSIGNED_DATEstatic StringJSON_PROPERTY_ASSIGNED_IDstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_DISPLAY_DESCRIPTIONstatic StringJSON_PROPERTY_DISPLAY_NAMEstatic StringJSON_PROPERTY_DUE_DATEstatic StringJSON_PROPERTY_EXECUTED_BYstatic StringJSON_PROPERTY_EXECUTED_BY_SUBSTITUTEstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_LAST_UPDATE_DATEstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_PARENT_CASE_IDstatic StringJSON_PROPERTY_PRIORITYstatic StringJSON_PROPERTY_PROCESS_IDstatic StringJSON_PROPERTY_REACHED_STATE_DATEstatic StringJSON_PROPERTY_ROOT_CASE_IDstatic StringJSON_PROPERTY_ROOT_CONTAINER_IDstatic StringJSON_PROPERTY_STATEstatic StringJSON_PROPERTY_TYPE
-
Constructor Summary
Constructors Constructor Description Activity()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActivityactorId(String actorId)ActivityassignedDate(String assignedDate)ActivityassignedId(String assignedId)Activitydescription(String description)ActivitydisplayDescription(String displayDescription)ActivitydisplayName(String displayName)ActivitydueDate(String dueDate)booleanequals(Object o)ActivityexecutedBy(String executedBy)ActivityexecutedBySubstitute(String executedBySubstitute)StringgetActorId()the id of the actor that can execute this activity, null otherwiseStringgetAssignedDate()the date ('yyyy-MM-dd HH:mm:ss.SSS') when the current activity was assigned, for example '2014-10-17 16:05:42.626'StringgetAssignedId()the user id that this activity is assigned to, or 0 if it is unassignedStringgetDescription()the activity descriptionStringgetDisplayDescription()the human readable activity descriptionStringgetDisplayName()the human readable activity nameStringgetDueDate()the date ('yyyy-MM-dd HH:mm:ss.SSS') when this activity is due, for example '2014-10-17 16:05:42.626'StringgetExecutedBy()the id of the user who performed this activity.StringgetExecutedBySubstitute()the id of the user who did actually performed the activity when it has been done in the name of someone else.StringgetId()the activity idStringgetLastUpdateDate()the date ('yyyy-MM-dd HH:mm:ss.SSS') when this activity was last updated, for example '2014-10-17 16:05:42.626)StringgetName()the activity technical nameStringgetParentCaseId()the immediate containing process instance id (long, a.k.a process instance id)ActivityPrioritygetPriority()Get priorityStringgetProcessId()the process definition id of the process instance which define this activityStringgetReachedStateDate()the date ('yyyy-MM-dd HH:mm:ss.SSS') when this activity reached the current state, for example '2014-10-17 16:05:42.626'StringgetRootCaseId()the top/root process instance id (long, a.k.a case id).StringgetRootContainerId()same as rootCaseIdActivityStategetState()Get stateActivityTypegetType()Get typeinthashCode()Activityid(String id)ActivitylastUpdateDate(String lastUpdateDate)Activityname(String name)ActivityparentCaseId(String parentCaseId)Activitypriority(ActivityPriority priority)ActivityprocessId(String processId)ActivityreachedStateDate(String reachedStateDate)ActivityrootCaseId(String rootCaseId)ActivityrootContainerId(String rootContainerId)voidsetActorId(String actorId)voidsetAssignedDate(String assignedDate)voidsetAssignedId(String assignedId)voidsetDescription(String description)voidsetDisplayDescription(String displayDescription)voidsetDisplayName(String displayName)voidsetDueDate(String dueDate)voidsetExecutedBy(String executedBy)voidsetExecutedBySubstitute(String executedBySubstitute)voidsetId(String id)voidsetLastUpdateDate(String lastUpdateDate)voidsetName(String name)voidsetParentCaseId(String parentCaseId)voidsetPriority(ActivityPriority priority)voidsetProcessId(String processId)voidsetReachedStateDate(String reachedStateDate)voidsetRootCaseId(String rootCaseId)voidsetRootContainerId(String rootContainerId)voidsetState(ActivityState state)voidsetType(ActivityType type)Activitystate(ActivityState state)StringtoString()Activitytype(ActivityType type)
-
-
-
Field Detail
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DISPLAY_NAME
public static final String JSON_PROPERTY_DISPLAY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DISPLAY_DESCRIPTION
public static final String JSON_PROPERTY_DISPLAY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STATE
public static final String JSON_PROPERTY_STATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REACHED_STATE_DATE
public static final String JSON_PROPERTY_REACHED_STATE_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LAST_UPDATE_DATE
public static final String JSON_PROPERTY_LAST_UPDATE_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DUE_DATE
public static final String JSON_PROPERTY_DUE_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIORITY
public static final String JSON_PROPERTY_PRIORITY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PROCESS_ID
public static final String JSON_PROPERTY_PROCESS_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PARENT_CASE_ID
public static final String JSON_PROPERTY_PARENT_CASE_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ROOT_CASE_ID
public static final String JSON_PROPERTY_ROOT_CASE_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ROOT_CONTAINER_ID
public static final String JSON_PROPERTY_ROOT_CONTAINER_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXECUTED_BY
public static final String JSON_PROPERTY_EXECUTED_BY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXECUTED_BY_SUBSTITUTE
public static final String JSON_PROPERTY_EXECUTED_BY_SUBSTITUTE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ACTOR_ID
public static final String JSON_PROPERTY_ACTOR_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ASSIGNED_ID
public static final String JSON_PROPERTY_ASSIGNED_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ASSIGNED_DATE
public static final String JSON_PROPERTY_ASSIGNED_DATE
- See Also:
- Constant Field Values
-
-
Method Detail
-
setId
public void setId(String id)
-
type
public Activity type(ActivityType type)
-
getType
@Nullable public ActivityType getType()
Get type- Returns:
- type
-
setType
public void setType(ActivityType type)
-
setName
public void setName(String name)
-
getDisplayName
@Nullable public String getDisplayName()
the human readable activity name- Returns:
- displayName
-
setDisplayName
public void setDisplayName(String displayName)
-
getDescription
@Nullable public String getDescription()
the activity description- Returns:
- description
-
setDescription
public void setDescription(String description)
-
getDisplayDescription
@Nullable public String getDisplayDescription()
the human readable activity description- Returns:
- displayDescription
-
setDisplayDescription
public void setDisplayDescription(String displayDescription)
-
state
public Activity state(ActivityState state)
-
getState
@Nullable public ActivityState getState()
Get state- Returns:
- state
-
setState
public void setState(ActivityState state)
-
getReachedStateDate
@Nullable public String getReachedStateDate()
the date ('yyyy-MM-dd HH:mm:ss.SSS') when this activity reached the current state, for example '2014-10-17 16:05:42.626'- Returns:
- reachedStateDate
-
setReachedStateDate
public void setReachedStateDate(String reachedStateDate)
-
getLastUpdateDate
@Nullable public String getLastUpdateDate()
the date ('yyyy-MM-dd HH:mm:ss.SSS') when this activity was last updated, for example '2014-10-17 16:05:42.626)- Returns:
- lastUpdateDate
-
setLastUpdateDate
public void setLastUpdateDate(String lastUpdateDate)
-
getDueDate
@Nullable public String getDueDate()
the date ('yyyy-MM-dd HH:mm:ss.SSS') when this activity is due, for example '2014-10-17 16:05:42.626'- Returns:
- dueDate
-
setDueDate
public void setDueDate(String dueDate)
-
priority
public Activity priority(ActivityPriority priority)
-
getPriority
@Nullable public ActivityPriority getPriority()
Get priority- Returns:
- priority
-
setPriority
public void setPriority(ActivityPriority priority)
-
getProcessId
@Nullable public String getProcessId()
the process definition id of the process instance which define this activity- Returns:
- processId
-
setProcessId
public void setProcessId(String processId)
-
getParentCaseId
@Nullable public String getParentCaseId()
the immediate containing process instance id (long, a.k.a process instance id)- Returns:
- parentCaseId
-
setParentCaseId
public void setParentCaseId(String parentCaseId)
-
getRootCaseId
@Nullable public String getRootCaseId()
the top/root process instance id (long, a.k.a case id). In case of an event sub process, `parentCaseId` will the id of the process instance called while `rootCaseId` will be the one from the caller process instance- Returns:
- rootCaseId
-
setRootCaseId
public void setRootCaseId(String rootCaseId)
-
getRootContainerId
@Nullable public String getRootContainerId()
same as rootCaseId- Returns:
- rootContainerId
-
setRootContainerId
public void setRootContainerId(String rootContainerId)
-
getExecutedBy
@Nullable public String getExecutedBy()
the id of the user who performed this activity. The activity has to be a human task otherwise its value will be 0- Returns:
- executedBy
-
setExecutedBy
public void setExecutedBy(String executedBy)
-
getExecutedBySubstitute
@Nullable public String getExecutedBySubstitute()
the id of the user who did actually performed the activity when it has been done in the name of someone else. Value is 0 otherwise- Returns:
- executedBySubstitute
-
setExecutedBySubstitute
public void setExecutedBySubstitute(String executedBySubstitute)
-
getActorId
@Nullable public String getActorId()
the id of the actor that can execute this activity, null otherwise- Returns:
- actorId
-
setActorId
public void setActorId(String actorId)
-
getAssignedId
@Nullable public String getAssignedId()
the user id that this activity is assigned to, or 0 if it is unassigned- Returns:
- assignedId
-
setAssignedId
public void setAssignedId(String assignedId)
-
getAssignedDate
@Nullable public String getAssignedDate()
the date ('yyyy-MM-dd HH:mm:ss.SSS') when the current activity was assigned, for example '2014-10-17 16:05:42.626'- Returns:
- assignedDate
-
setAssignedDate
public void setAssignedDate(String assignedDate)
-
-