All Superinterfaces:: org.flowable.common.engine.api.history.HistoricData

All Known Subinterfaces:: HistoricWorkObjectEntity

All Known Implementing Classes:: HistoricCaseWorkObject, HistoricProcessWorkObject, HistoricTaskWorkObject, HistoricWorkObjectEntityImpl, HistoryIdentityLinkRelatedWorkObject

public interface HistoricWorkObject
extends org.flowable.common.engine.api.history.HistoricData

An object structure representing a values of the WorkObject which are keeping historic information.

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`getAssignedGroupId()`	Returns the historic work object assigned group ID.
`java.util.Date`	`getAssignedGroupIdUpdateTime()`	Returns the time the entity's assigned group ID was last updated.
`java.lang.String`	`getAssigneeId()`	Returns the historic work object assignee's user ID.
`java.util.Date`	`getAssigneeIdUpdateTime()`	Returns the time the entity's assignee ID was last updated.
`java.util.Set<java.lang.String>`	`getCandidateGroupIds()`	Returns the historic work object candidate group IDs.
`java.util.Set<java.lang.String>`	`getCandidateUserIds()`	Returns the historic work object candidate user IDs.
`java.util.Date`	`getCreationTime()`	Returns the time the entity was created.
`java.lang.String`	`getDefinitionId()`	Returns the definition ID of this historic work object.
`java.util.Date`	`getDueTime()`	Returns the historic work object due time.
`java.lang.String`	`getExternalId()`	Returns the external ID of this historic work object.
`java.lang.String`	`getGlobalId()`	Returns the global ID of this historic work object.
`java.lang.String`	`getId()`	Returns the ID of this historic work object.
`java.lang.String`	`getInitialAssignedGroupId()`	Returns the initial assigned group ID.
`java.lang.String`	`getInitialAssigneeId()`	Returns the initial assignee's user ID.
`java.lang.String`	`getModificationCreatorId()`	Returns the ID of the user who created the historic work object.
`java.lang.String`	`getModificationUpdaterId()`	Returns the ID of the user who last modified the historic work object.
`long`	`getModificationVersion()`	Returns the historic work object modification version.
`java.lang.String`	`getName()`	Returns the historic work object name.
`java.lang.String`	`getOwnerId()`	Returns the historic work object owner's user ID.
`java.lang.String`	`getParentId()`	Returns parent id
`java.lang.String`	`getParentIdRef()`	Returns parent id reference
`java.util.List<java.lang.String>`	`getPath()`	Returns the historic work object hierarchy path (i.e.
`java.lang.String`	`getPreviousAssignedGroupId()`	Returns the previous assigned group ID.
`java.lang.String`	`getPreviousAssigneeId()`	Returns the previous assignee's user ID.
`java.lang.Integer`	`getPriority()`	Returns the historic work object priority.
`java.lang.String`	`getProviderId()`	Returns the provider ID of this historic work object.
`java.util.Date`	`getResubmissionTime()`	Returns the historic work object resubmission time.
`java.lang.String`	`getRootId()`	Returns the ID of the root historic work object (may be historic work object ID of this historic work object).
`java.lang.String`	`getState()`	Returns the historic work object state.
`java.util.Date`	`getStateUpdateTime()`	Returns the time the historic work object state was last updated.
`java.lang.String`	`getSubState()`	Returns the historic work object sub-state.
`java.util.Date`	`getSubStateUpdateTime()`	Returns the time the historic work object sub state was last updated.
`java.lang.String`	`getTenantId()`	Returns the tenant ID for this historic work object.
`java.lang.String`	`getType()`	Returns the work object type.
`java.util.Date`	`getUpdateTime()`	Returns the time the entity was last updated.

Methods inherited from interface org.flowable.common.engine.api.history.HistoricData

getTime

Method Details
- getType
  
  java.lang.String getType()
  
  Returns the work object type.
  
  Returns:
  
  the historic work object type
- getId
  
  java.lang.String getId()
  
  Returns the ID of this historic work object.
  The ID is used to uniquely identify this particular historic work object instance.
  
  Returns:
  
  the historic work object ID
- getProviderId
  
  java.lang.String getProviderId()
  
  Returns the provider ID of this historic work object.
  The ID is used to identify the provider responsible for managing the historic work object.
  
  Returns:
  
  the historic work object provider ID
- getExternalId
  
  java.lang.String getExternalId()
  
  Returns the external ID of this historic work object.
  The external ID is used by the provider for managing the historic work object.
  
  Returns:
  
  the historic work object external ID
- getDefinitionId
  
  java.lang.String getDefinitionId()
  
  Returns the definition ID of this historic work object.
  The definition ID references a definition that provides template information for the historic work object.
  
  Returns:
  
  the definition ID
- getGlobalId
  
  java.lang.String getGlobalId()
  
  Returns the global ID of this historic work object.
  The global ID is used to identify this entity represented by this historic work object. Historic 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 historic work object type.
  
  Returns:
  
  the global ID
- getTenantId
  
  java.lang.String getTenantId()
  
  Returns the tenant ID for this historic 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 historic work object belongs to a specific tenant.
  
  Returns:
  
  the tenant ID
- getName
  
  java.lang.String getName()
  
  Returns the historic work object name.
  
  Returns:
  
  the historic work object name
- getState
  
  java.lang.String getState()
  
  Returns the historic work object state.
  
  Returns:
  
  the historic work object state
- getSubState
  
  java.lang.String getSubState()
  
  Returns the historic work object sub-state.
  
  Returns:
  
  the historic work object sub-state
- getOwnerId
  
  java.lang.String getOwnerId()
  
  Returns the historic work object owner's user ID.
  
  Returns:
  
  the historic work object owner's user ID
- getAssigneeId
  
  java.lang.String getAssigneeId()
  
  Returns the historic work object assignee's user ID.
  
  Returns:
  
  the historic work object assignee's user ID
- getAssignedGroupId
  
  java.lang.String getAssignedGroupId()
  
  Returns the historic work object assigned group ID.
  
  Returns:
  
  the historic work object assigned group ID
- getCandidateUserIds
  
  java.util.Set<java.lang.String> getCandidateUserIds()
  
  Returns the historic work object candidate user IDs.
  
  Returns:
  
  the historic work object candidate user IDs
- getCandidateGroupIds
  
  java.util.Set<java.lang.String> getCandidateGroupIds()
  
  Returns the historic work object candidate group IDs.
  
  Returns:
  
  the historic work object candidate group IDs
- getPriority
  
  java.lang.Integer getPriority()
  
  Returns the historic work object priority.
  
  Returns:
  
  the historic work object priority
- getResubmissionTime
  
  java.util.Date getResubmissionTime()
  
  Returns the historic work object resubmission time.
  
  Returns:
  
  the historic work object resubmission time
- getDueTime
  
  java.util.Date getDueTime()
  
  Returns the historic work object due time.
  
  Returns:
  
  the historic work object due time
- getModificationCreatorId
  
  java.lang.String getModificationCreatorId()
  
  Returns the ID of the user who created the historic work object.
  
  Returns:
  
  the ID of the user who created the historic 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 historic work object hierarchy path (i.e. the sequence of parent IDs to the root historic work object).
  The entries in the path are ordered from the highest level (root) to the lowest level (current historic work object).
  
  Returns:
  
  the historic work object hierarchy path
- getRootId
  
  java.lang.String getRootId()
  
  Returns the ID of the root historic work object (may be historic work object ID of this historic work object).
  
  Returns:
  
  the ID of the root historic work object (may be historic work object ID of this historic work object)
- getStateUpdateTime
  
  java.util.Date getStateUpdateTime()
  
  Returns the time the historic work object state was last updated.
  
  Returns:
  
  the time the historic work object state was last updated
- getSubStateUpdateTime
  
  java.util.Date getSubStateUpdateTime()
  
  Returns the time the historic work object sub state was last updated.
  
  Returns:
  
  the time the historic 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 historic work object modification version.
  The modification version is changed each time the historic work object is modified.
  
  Returns:
  
  the historic work object modification version
- getModificationUpdaterId
  
  java.lang.String getModificationUpdaterId()
  
  Returns the ID of the user who last modified the historic work object.
  
  Returns:
  
  the ID of the user who last modified the historic 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

Interface HistoricWorkObject

Method Summary

Methods inherited from interface org.flowable.common.engine.api.history.HistoricData

Method Details