com.edorasware.commons.core.entity

Class WorkObject<T extends WorkObjectId,D extends WorkObjectDefinitionId,P extends Id>

java.lang.Object

com.edorasware.commons.core.entity.Entity<T,P>

com.edorasware.commons.core.entity.DomainObject<T,D,P>

com.edorasware.commons.core.entity.WorkObject<T,D,P>

Type Parameters:

T - The type of the id/externalId

D - The type of the definitionId

P - The type of the providerId

All Implemented Interfaces:

HierarchicalEntity<WorkObjectId,T>, Identifiable<T>

Direct Known Subclasses:

AnyWorkObject

public abstract class WorkObject<T extends WorkObjectId,D extends WorkObjectDefinitionId,P extends Id>
extends DomainObject<T,D,P>
implements HierarchicalEntity<WorkObjectId,T>

Base class for all work objects that participate in a BPM system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkObject.WorkObjectBuilder<T extends WorkObjectId,D extends WorkObjectDefinitionId,P extends Id,E extends WorkObject<T,D,P>,SELF extends WorkObject.WorkObjectBuilder<T,D,P,E,SELF>>
protected static class	WorkObject.WorkObjectData Data container that holds the state of a work object.

Nested classes/interfaces inherited from class com.edorasware.commons.core.entity.DomainObject

DomainObject.DomainObjectBuilder<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,SELF extends DomainObject.DomainObjectBuilder<T,D,P,E,SELF>>, DomainObject.DomainObjectData<T extends EntityId,D extends EntityId,P extends Id>

Nested classes/interfaces inherited from class com.edorasware.commons.core.entity.Entity

Entity.EntityBuilder<T extends EntityId,P extends Id,E extends Entity<T,P>,SELF extends Entity.EntityBuilder<T,P,E,SELF>>, Entity.EntityData<T extends EntityId,P extends Id>

Nested classes/interfaces inherited from interface com.edorasware.commons.core.entity.HierarchicalEntity

HierarchicalEntity.HierarchicalEntityBuilder<T extends HierarchicalEntityId,SELF extends HierarchicalEntity.HierarchicalEntityBuilder<T,SELF>>

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkObject.WorkObjectData	workObjectData

Fields inherited from class com.edorasware.commons.core.entity.DomainObject

domainObjectData, VARIABLE_DELETED_VALUE

Fields inherited from class com.edorasware.commons.core.entity.Entity

entityData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkObject(Entity.EntityData<T,P> entityData, DomainObject.DomainObjectData<T,D,P> domainObjectData, WorkObject.WorkObjectData workObjectData)

Method Summary

Modifier and Type	Method and Description
protected void	collectToStringAttributes(org.springframework.core.style.ToStringCreator toStringCreator)
GroupId	getAssignedGroupId() Returns the current assigned group of the entity.
Date	getAssignedGroupIdUpdateTime() Returns the time the entity's assigned group was last updated.
UserId	getAssigneeId() Returns the current assignee of the entity.
Date	getAssigneeIdUpdateTime() Returns the time the entity's assignee was last updated.
Set<GroupId>	getCandidateGroupIds() Returns the candidate groups of the entity.
Set<UserId>	getCandidateUserIds() Returns the candidate users of the entity.
Date	getDueTime() Returns the time that the entity is due.
GroupId	getInitialAssignedGroupId() Returns the initial assigned group of the entity.
UserId	getInitialAssigneeId() Returns the initial assignee of the entity.
UserId	getOwnerId() Returns the owner of the entity.
WorkObjectId	getParentId() Returns the id of the parent entity.
<T extends WorkObjectId> T	getParentId(Class<T> expectedParentType) Returns the first parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.
List<? extends WorkObjectId>	getPath() Returns the path of the hierarchy to which the entity belongs.
GroupId	getPreviousAssignedGroupId() Returns the previous assigned group of the entity.
UserId	getPreviousAssigneeId() Returns the previous assignee of the entity.
Integer	getPriority() Returns the priority of the entity.
Date	getResubmissionTime() Returns the time the entity needs to be resubmitted.
WorkObjectId	getRootId() Implements backward compatibility for data with case as a workobject root.
State	getState() Returns the current state of the entity.
<T extends WorkObjectId> T	getTopMostParentId(Class<T> expectedParentType) Returns the topmost parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.
boolean	hasParent() Returns true if the entity has a parent.
boolean	isActive() Returns true if the entity is in state ACTIVE.
boolean	isCompleted() Returns true if the entity is in state COMPLETED.
boolean	isInterrupted() Returns true if the entity is in state INTERRUPTED.
String	toString()

Methods inherited from class com.edorasware.commons.core.entity.DomainObject

getDefinitionId, getLocalVariable, getLocalVariables, getLocalVariables, getLocalVariablesMap, getLocalVariablesMap, getLocalVariableValue, getLocalVariableValue, getLocalVariableValue, getLocalVariableValue, getStateUpdateTime, getSubState, getSubStateUpdateTime, getVariable, getVariables, getVariables, getVariablesMap, getVariablesMap, getVariableValue, getVariableValue, getVariableValue, getVariableValue, hasLocalVariable, hasLocalVariable, hasVariable, hasVariable

Methods inherited from class com.edorasware.commons.core.entity.Entity

getCreationTime, getDescription, getExternalId, getGlobalId, getId, getModificationCreatorId, getModificationUpdaterId, getModificationVersion, getName, getProviderId, getTenantId, getType, getUpdateTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Field Detail

workObjectData

protected final WorkObject.WorkObjectData workObjectData

Constructor Detail

WorkObject

protected WorkObject(Entity.EntityData<T,P> entityData,
                     DomainObject.DomainObjectData<T,D,P> domainObjectData,
                     WorkObject.WorkObjectData workObjectData)

Method Detail

getState

public State getState()

Returns the current state of the entity.

Overrides:

getState in class DomainObject<T extends WorkObjectId,D extends WorkObjectDefinitionId,P extends Id>

Returns:

the state of the entity

See Also:

WorkObjectState

getOwnerId

public UserId getOwnerId()

Returns the owner of the entity.

Returns:

the owner of the entity

getAssigneeId

public UserId getAssigneeId()

Returns the current assignee of the entity.

Returns:

the current assignee of the entity

getInitialAssigneeId

public UserId getInitialAssigneeId()

Returns the initial assignee of the entity.

Returns:

the initial assignee of the entity

getPreviousAssigneeId

public UserId getPreviousAssigneeId()

Returns the previous assignee of the entity.

Returns:

the previous assignee of the entity

getAssignedGroupId

public GroupId getAssignedGroupId()

Returns the current assigned group of the entity.

Returns:

the current assigned group of the entity

getInitialAssignedGroupId

public GroupId getInitialAssignedGroupId()

Returns the initial assigned group of the entity.

Returns:

the initial assigned group of the entity

getPreviousAssignedGroupId

public GroupId getPreviousAssignedGroupId()

Returns the previous assigned group of the entity.

Returns:

the previous assigned group of the entity

getCandidateUserIds

public Set<UserId> getCandidateUserIds()

Returns the candidate users of the entity.

Returns:

the candidate users of the entity

getCandidateGroupIds

public Set<GroupId> getCandidateGroupIds()

Returns the candidate groups of the entity.

Returns:

the candidate groups of the entity

getPriority

public Integer getPriority()

Returns the priority of the entity.

Returns:

the priority of the entity

getResubmissionTime

public Date getResubmissionTime()

Returns the time the entity needs to be resubmitted.

Returns:

the resubmission time of the entity

getDueTime

public Date getDueTime()

Returns the time that the entity is due.

Returns:

the due time of the entity

getAssigneeIdUpdateTime

public Date getAssigneeIdUpdateTime()

Returns the time the entity's assignee was last updated.

Returns:

the last update time of the entity's assignee

getAssignedGroupIdUpdateTime

public Date getAssignedGroupIdUpdateTime()

Returns the time the entity's assigned group was last updated.

Returns:

the last update time of the entity's assigned group

getPath

public List<? extends WorkObjectId> getPath()

Description copied from interface: HierarchicalEntity

Returns the path of the hierarchy to which the entity belongs. The path starts with the root and ends with the entity itself, when iterating through the list from beginning to end.

Specified by:

getPath in interface HierarchicalEntity<WorkObjectId,T extends WorkObjectId>

Returns:

the hierarchy path

getRootId

public WorkObjectId getRootId()

Implements backward compatibility for data with case as a workobject root.

Specified by:

getRootId in interface HierarchicalEntity<WorkObjectId,T extends WorkObjectId>

Returns:

root workobject in the given path

hasParent

public boolean hasParent()

Description copied from interface: HierarchicalEntity

Returns true if the entity has a parent.

Specified by:

hasParent in interface HierarchicalEntity<WorkObjectId,T extends WorkObjectId>

Returns:

true if the entity has a parent

getParentId

public WorkObjectId getParentId()

Description copied from interface: HierarchicalEntity

Returns the id of the parent entity.

Specified by:

getParentId in interface HierarchicalEntity<WorkObjectId,T extends WorkObjectId>

Returns:

the parent entity id, or null if the entity has no parent

getParentId

public <T extends WorkObjectId> T getParentId(Class<T> expectedParentType)

Description copied from interface: HierarchicalEntity

Returns the first parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.

Specified by:

getParentId in interface HierarchicalEntity<WorkObjectId,T extends WorkObjectId>

Type Parameters:

T - the type of the parent class

Parameters:

expectedParentType - the expected parent type

Returns:

the first parent of the entity of the expected type, or null

getTopMostParentId

public <T extends WorkObjectId> T getTopMostParentId(Class<T> expectedParentType)

Description copied from interface: HierarchicalEntity

Returns the topmost parent of the entity that is of the expected type when walking up the path from the immediate parent to the root.

Specified by:

getTopMostParentId in interface HierarchicalEntity<WorkObjectId,T extends WorkObjectId>

Type Parameters:

T - the type of the parent class

Parameters:

expectedParentType - the expected parent type

Returns:

the topmost parent of the entity of the expected type, or null

isActive

public boolean isActive()

Returns true if the entity is in state ACTIVE.

Returns:

true if the entity is ACTIVE

See Also:

getState(), WorkObjectState.ACTIVE

isCompleted

public boolean isCompleted()

Returns true if the entity is in state COMPLETED.

Returns:

true if the entity is COMPLETED

See Also:

getState(), WorkObjectState.COMPLETED

isInterrupted

public boolean isInterrupted()

Returns true if the entity is in state INTERRUPTED.

Returns:

true if the entity is INTERRUPTED

See Also:

getState(), WorkObjectState.INTERRUPTED

toString

public String toString()

Specified by:

toString in class Entity<T extends WorkObjectId,P extends Id>

collectToStringAttributes

protected void collectToStringAttributes(org.springframework.core.style.ToStringCreator toStringCreator)