Class 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
    • Constructor Detail

      • Activity

        public Activity()
    • Method Detail

      • setId

        public void setId​(String id)
      • getName

        @Nullable
        public String getName()
        the activity technical name
        Returns:
        name
      • 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)
      • displayDescription

        public Activity displayDescription​(String displayDescription)
      • getDisplayDescription

        @Nullable
        public String getDisplayDescription()
        the human readable activity description
        Returns:
        displayDescription
      • setDisplayDescription

        public void setDisplayDescription​(String displayDescription)
      • reachedStateDate

        public Activity reachedStateDate​(String reachedStateDate)
      • 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)
      • lastUpdateDate

        public Activity lastUpdateDate​(String lastUpdateDate)
      • 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)
      • 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)
      • parentCaseId

        public Activity parentCaseId​(String parentCaseId)
      • 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)
      • rootContainerId

        public Activity rootContainerId​(String rootContainerId)
      • 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)
      • executedBySubstitute

        public Activity executedBySubstitute​(String executedBySubstitute)
      • 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)
      • assignedDate

        public Activity assignedDate​(String assignedDate)
      • 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)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object