Package com.flowable.workobject.api

Interface WorkObject

All Known Subinterfaces:
WorkObjectEntity
All Known Implementing Classes:
CaseWorkObject, DefaultWorkObjectUpdater, IdentityLinkRelatedWorkObject, ProcessWorkObject, TaskWorkObject, WorkObjectEntityImpl
public interface WorkObject
An object structure representing a workObject.
Author:
Tijs Rademakers, Joram Barez

  • Method Details

    • getType

      java.lang.String getType()
      Returns the work object type.
      Returns:
      the work object type

    • getId

      java.lang.String getId()
      Returns the ID of this work object.

      The ID is used to uniquely identify this particular work object instance.

      Returns:
      the work object ID

    • getProviderId

      java.lang.String getProviderId()
      Returns the provider ID of this work object.

      The ID is used to identify the provider responsible for managing the work object.

      Returns:
      the work object provider ID

    • getExternalId

      java.lang.String getExternalId()
      Returns the external ID of this work object.

      The external ID is used by the provider for managing the work object.

      Returns:
      the work object external ID

    • getDefinitionId

      java.lang.String getDefinitionId()
      Returns the definition ID of this work object.

      The definition ID references a definition that provides template information for the work object.

      Returns:
      the definition ID

    • getGlobalId

      java.lang.String getGlobalId()
      Returns the global ID of this work object.

      The global ID is used to identify this entity represented by this work object. Work objects in different tenants or even in different systems that represent the same entity will have the same global ID. Management of global IDs will vary depending on the application and the work object type.

      Returns:
      the global ID

    • getTenantId

      java.lang.String getTenantId()
      Returns the tenant ID for this work object.

      A single edoras one system can support multiple tenants, where each tenant is an isolated environment. Each tenant has a tenant ID, and a work object belongs to a specific tenant.

      Returns:
      the tenant ID

    • getName

      java.lang.String getName()
      Returns the work object name.
      Returns:
      the work object name

    • setName

      void setName​(java.lang.String name)

    • getState

      java.lang.String getState()
      Returns the work object state.
      Returns:
      the work object state

    • getSubState

      java.lang.String getSubState()
      Returns the work object sub-state.
      Returns:
      the work object sub-state {}

    • getOwnerId

      java.lang.String getOwnerId()
      Returns the work object owner's user ID.
      Returns:
      the work object owner's user ID

    • setOwnerId

      void setOwnerId​(java.lang.String ownerId)

    • getAssigneeId

      java.lang.String getAssigneeId()
      Returns the work object assignee's user ID.
      Returns:
      the work object assignee's user ID

    • setAssigneeId

      void setAssigneeId​(java.lang.String assigneeId)

    • getAssignedGroupId

      java.lang.String getAssignedGroupId()
      Returns the work object assigned group ID.
      Returns:
      the work object assigned group ID

    • setAssignedGroupId

      void setAssignedGroupId​(java.lang.String assignedGroupId)

    • getCandidateUserIds

      java.util.Set<java.lang.String> getCandidateUserIds()
      Returns the work object candidate user IDs.
      Returns:
      the work object candidate user IDs

    • setCandidateUserIds

      void setCandidateUserIds​(java.util.Set<java.lang.String> candidateUsers)

    • getCandidateGroupIds

      java.util.Set<java.lang.String> getCandidateGroupIds()
      Returns the work object candidate group IDs.
      Returns:
      the work object candidate group IDs

    • setCandidateGroupIds

      void setCandidateGroupIds​(java.util.Set<java.lang.String> candidateGroups)

    • getPriority

      java.lang.Integer getPriority()
      Returns the work object priority.
      Returns:
      the work object priority

    • setPriority

      void setPriority​(java.lang.Integer priority)

    • getResubmissionTime

      java.util.Date getResubmissionTime()
      Returns the work object resubmission time.
      Returns:
      the work object resubmission time

    • getDueTime

      java.util.Date getDueTime()
      Returns the work object due time.
      Returns:
      the work object due time

    • setDueTime

      void setDueTime​(java.util.Date dueDate)

    • getModificationCreatorId

      java.lang.String getModificationCreatorId()
      Returns the ID of the user who created the work object.
      Returns:
      the ID of the user who created the work object

    • getCreationTime

      java.util.Date getCreationTime()
      Returns the time the entity was created.
      Returns:
      the time the entity was created

    • getPath

      java.util.List<java.lang.String> getPath()
      Returns the work object hierarchy path (i.e. the sequence of parent IDs to the root work object).

      The entries in the path are ordered from the highest level (root) to the lowest level (current work object).

      Returns:
      the work object hierarchy path

    • getRootId

      java.lang.String getRootId()
      Returns the ID of the root work object (may be work object ID of this work object).
      Returns:
      the ID of the root work object (may be work object ID of this work object)

    • getStateUpdateTime

      java.util.Date getStateUpdateTime()
      Returns the time the work object state was last updated.
      Returns:
      the time the work object state was last updated

    • getSubStateUpdateTime

      java.util.Date getSubStateUpdateTime()
      Returns the time the work object sub state was last updated.
      Returns:
      the time the work object sub state was last updated

    • getInitialAssigneeId

      java.lang.String getInitialAssigneeId()
      Returns the initial assignee's user ID.
      Returns:
      the initial assignee's user ID

    • getPreviousAssigneeId

      java.lang.String getPreviousAssigneeId()
      Returns the previous assignee's user ID.
      Returns:
      the previous assignee's user ID

    • getAssigneeIdUpdateTime

      java.util.Date getAssigneeIdUpdateTime()
      Returns the time the entity's assignee ID was last updated.
      Returns:
      the time the entity's assignee ID was last updated

    • getInitialAssignedGroupId

      java.lang.String getInitialAssignedGroupId()
      Returns the initial assigned group ID.
      Returns:
      the initial assigned group ID

    • getPreviousAssignedGroupId

      java.lang.String getPreviousAssignedGroupId()
      Returns the previous assigned group ID.
      Returns:
      the previous assigned group ID

    • getAssignedGroupIdUpdateTime

      java.util.Date getAssignedGroupIdUpdateTime()
      Returns the time the entity's assigned group ID was last updated.
      Returns:
      the time the entity's assigned group ID was last updated

    • getModificationVersion

      long getModificationVersion()
      Returns the work object modification version.

      The modification version is changed each time the work object is modified.

      Returns:
      the work object modification version

    • getModificationUpdaterId

      java.lang.String getModificationUpdaterId()
      Returns the ID of the user who last modified the work object.
      Returns:
      the ID of the user who last modified the work object

    • getUpdateTime

      java.util.Date getUpdateTime()
      Returns the time the entity was last updated.
      Returns:
      the time the entity was last updated

    • getParentIdRef

      java.lang.String getParentIdRef()
      Returns parent id reference
      Returns:
      parent id reference

    • getParentId

      java.lang.String getParentId()
      Returns parent id
      Returns:
      parent id

    • getParentType

      java.lang.String getParentType()
      Returns parent type
      Returns:
      parent type

    • getLegacyVariables

      java.util.List<LegacyVariable> getLegacyVariables()
      Returns:
      variables associated with the work object

    • isHasLegacyVariables

      boolean isHasLegacyVariables()
      Flag to specify whether workObject contains legacy variables
      Returns:
      true if there are legacy variables in the work object, false otherwise

    • getWorkObjectVariables

      java.util.Map<java.lang.String,​java.lang.Object> getWorkObjectVariables()
      Returns the WorkObject variables if requested in the WorkObjectQuery