AnyWorkObject (edoras one Java API (2.0.7))

java.lang.Object
- com.edorasware.commons.core.entity.Entity
- - com.edorasware.commons.core.any.AnyWorkObject

All Implemented Interfaces:

HierarchicalEntity, Identifiable
```
public class AnyWorkObject
extends Entity
implements HierarchicalEntity
```
Represents a concrete work object. Note: This class is useful when working with work objects in a generic way.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AnyWorkObject.Builder
Builder for a AnyWorkObject instance.
- Nested classes/interfaces inherited from class com.edorasware.commons.core.entity.Entity
 Entity.EntityBuilder<E extends Entity,SELF extends Entity.EntityBuilder<E,SELF>>
- Nested classes/interfaces inherited from interface com.edorasware.commons.core.entity.HierarchicalEntity
 HierarchicalEntity.HierarchicalEntityBuilder<SELF extends HierarchicalEntity.HierarchicalEntityBuilder<SELF>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`AnyWorkObject.Builder` Builder for a AnyWorkObject instance.

Field Summary

Fields
Modifier and Type	Field and Description
`static Optional<Object>`	`VARIABLE_DELETED_VALUE` Variable value used inside the `DomainObjectModification` as a flag to delete the variables in the next update.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static AnyWorkObject.Builder`	`builder()` Creates a builder for a new concrete work object instance.
`static AnyWorkObject.Builder`	`builder(AnyWorkObject template)` Creates a builder for a new concrete work object instance and applies the given template.
`String`	`getAssignedGroupId()` Returns the current assigned group of the entity.
`Instant`	`getAssignedGroupIdUpdateTime()` Returns the time the entity’s assigned group was last updated.
`String`	`getAssigneeId()` Returns the current assignee of the entity.
`Instant`	`getAssigneeIdUpdateTime()` Returns the time the entity’s assignee was last updated.
`Set<String>`	`getCandidateGroupIds()` Returns the candidate groups of the entity.
`Set<String>`	`getCandidateUserIds()` Returns the candidate users of the entity.
`String`	`getDefinitionId()` Returns the definition id of the entity.
`Instant`	`getDueTime()` Returns the time that the entity is due.
`String`	`getInitialAssignedGroupId()` Returns the initial assigned group of the entity.
`String`	`getInitialAssigneeId()` Returns the initial assignee of the entity.
`Variable`	`getLocalVariable(String name)` Returns the local variable with the given name.
`List<Variable>`	`getLocalVariables()` Returns the local variables of the entity.
`List<Variable>`	`getLocalVariables(com.google.common.base.Predicate<Variable> predicate)` Returns the local variables of the entity, filtered by the given predicate.
`Map<String,Object>`	`getLocalVariablesMap()` Returns the local variables of the entity as name/value pairs.
`Map<String,Object>`	`getLocalVariablesMap(com.google.common.base.Predicate<Variable> predicate)` Returns the local variables of the entity as name/value pairs, filtered by the given predicate.
`Object`	`getLocalVariableValue(String name)` Returns the value of the local variable with the given name.
`<T> T`	`getLocalVariableValue(String name, Class<T> expectedType)` Returns the value of the local variable with the given name, cast to the expected type.
`<T> T`	`getLocalVariableValue(String name, com.google.common.reflect.TypeToken<T> expectedType)` Returns the value of the local variable with the given name, cast to the expected type.
`<V,W> V`	`getLocalVariableValue(ValueAccessor<V> variableAccessor)` Returns the value of the local variable with the name defined by the variable accessor, deserialized and cast to the type expected by the variable accessor.
`String`	`getOwnerId()` Returns the owner of the entity.
`String`	`getParentId()` Returns the id of the parent entity.
`List<String>`	`getPath()` Returns the path of the hierarchy to which the entity belongs.
`String`	`getPreviousAssignedGroupId()` Returns the previous assigned group of the entity.
`String`	`getPreviousAssigneeId()` Returns the previous assignee of the entity.
`Integer`	`getPriority()` Returns the priority of the entity.
`Instant`	`getResubmissionTime()` Returns the time the entity needs to be resubmitted.
`String`	`getRootId()` Implements backward compatibility for data with case as a workobject root.
`String`	`getState()` Returns the current state of the entity.
`Instant`	`getStateUpdateTime()` Returns the time the entity state was last updated.
`String`	`getSubState()` Returns the current sub state of the entity.
`Instant`	`getSubStateUpdateTime()` Returns the time the entity sub state was last updated.
`Variable`	`getVariable(String name)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariable(String)` method instead and recheck where you store the variables
`List<Variable>`	`getVariables()` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariables()` method instead and recheck where you store the variables
`List<Variable>`	`getVariables(com.google.common.base.Predicate<Variable> predicate)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariables(Predicate)` method instead and recheck where you store the variables
`Map<String,Object>`	`getVariablesMap()` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariablesMap()` method instead and recheck where you store the variables
`Map<String,Object>`	`getVariablesMap(com.google.common.base.Predicate<Variable> predicate)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariablesMap(Predicate)` method instead and recheck where you store the variables
`Object`	`getVariableValue(String name)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariableValue(String)` method instead and recheck where you store the variables
`<T> T`	`getVariableValue(String name, Class<T> expectedType)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariableValue(String, Class)` method instead and recheck where you store the variables
`<T> T`	`getVariableValue(String name, com.google.common.reflect.TypeToken<T> expectedType)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariableValue(String, Class)` method instead and recheck where you store the variables
`<V,W> V`	`getVariableValue(ValueAccessor<V> variableAccessor)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `getLocalVariableValue(ValueAccessor)` method instead and recheck where you store the variables
`boolean`	`hasLocalVariable(String name)` Returns <i>true</i> if the entity has a local variable with the given name.
`boolean`	`hasLocalVariable(ValueAccessor<?> variableAccessor)` Returns <i>true</i> if the entity has a local variable with the name of the given variable accessor.
`boolean`	`hasParent()` Returns <i>true</i> if the entity has a parent.
`boolean`	`hasVariable(String name)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `hasLocalVariable(String)` method instead and recheck where you store the variables
`boolean`	`hasVariable(ValueAccessor<?> variableAccessor)` Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the `hasLocalVariable(ValueAccessor)` method instead and recheck where you store the variables
`boolean`	`isActive()` Returns <i>true</i> if the entity is in state `ACTIVE`.
`boolean`	`isCompleted()` Returns <i>true</i> if the entity is in state `COMPLETED`.
`boolean`	`isInterrupted()` Returns <i>true</i> if the entity is in state `INTERRUPTED`.
`String`	`toString()`

Methods inherited from class com.edorasware.commons.core.entity.Entity
getCreationTime, getExternalId, getGlobalId, getId, getModificationCreatorId, getModificationUpdaterId, getModificationVersion, getName, getProviderId, getTenantId, getType, getUpdateTime

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
 - VARIABLE_DELETED_VALUE
```
public static final Optional<Object> VARIABLE_DELETED_VALUE
```
 Variable value used inside the DomainObjectModification as a flag to delete the variables in the next update.
- Method Detail
 - builder
```
public static AnyWorkObject.Builder builder()
```
 Creates a builder for a new concrete work object instance.
 
 Returns:
 
 the builder
 - builder
```
public static AnyWorkObject.Builder builder(AnyWorkObject template)
```
 Creates a builder for a new concrete work object instance and applies the given template.
 
 Parameters:
 
 template - the work object template
 
 Returns:
 
 the builder
 - getOwnerId
```
public String getOwnerId()
```
 Returns the owner of the entity.
 
 Returns:
 
 the owner of the entity
 - getAssigneeId
```
public String getAssigneeId()
```
 Returns the current assignee of the entity.
 
 Returns:
 
 the current assignee of the entity
 - getInitialAssigneeId
```
public String getInitialAssigneeId()
```
 Returns the initial assignee of the entity.
 
 Returns:
 
 the initial assignee of the entity
 - getPreviousAssigneeId
```
public String getPreviousAssigneeId()
```
 Returns the previous assignee of the entity.
 
 Returns:
 
 the previous assignee of the entity
 - getAssignedGroupId
```
public String getAssignedGroupId()
```
 Returns the current assigned group of the entity.
 
 Returns:
 
 the current assigned group of the entity
 - getInitialAssignedGroupId
```
public String getInitialAssignedGroupId()
```
 Returns the initial assigned group of the entity.
 
 Returns:
 
 the initial assigned group of the entity
 - getPreviousAssignedGroupId
```
public String getPreviousAssignedGroupId()
```
 Returns the previous assigned group of the entity.
 
 Returns:
 
 the previous assigned group of the entity
 - getCandidateUserIds
```
public Set<String> getCandidateUserIds()
```
 Returns the candidate users of the entity.
 
 Returns:
 
 the candidate users of the entity
 - getCandidateGroupIds
```
public Set<String> 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 Instant getResubmissionTime()
```
 Returns the time the entity needs to be resubmitted.
 
 Returns:
 
 the resubmission time of the entity
 - getDueTime
```
public Instant getDueTime()
```
 Returns the time that the entity is due.
 
 Returns:
 
 the due time of the entity
 - getAssigneeIdUpdateTime
```
public Instant getAssigneeIdUpdateTime()
```
 Returns the time the entity’s assignee was last updated.
 
 Returns:
 
 the last update time of the entity’s assignee
 - getAssignedGroupIdUpdateTime
```
public Instant 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<String> 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
 
 Returns:
 
 the hierarchy path
 - getRootId
```
public String getRootId()
```
 Implements backward compatibility for data with case as a workobject root.
 
 Specified by:
 
 getRootId in interface HierarchicalEntity
 
 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
 
 Returns:
 
 true if the entity has a parent
 - getParentId
```
public String getParentId()
```
 Description copied from interface: HierarchicalEntity
 
 Returns the id of the parent entity.
 
 Specified by:
 
 getParentId in interface HierarchicalEntity
 
 Returns:
 
 the parent entity id, or null if the entity has no parent
 - isActive
```
public boolean isActive()
```
 Returns true if the entity is in state ACTIVE.
 
 Returns:
 
 true if the entity is ACTIVE
 
 See Also:
 
 getState(), WorkObjectState.STATE_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.STATE_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.STATE_INTERRUPTED
 - toString
```
public String toString()
```
 Specified by:
 
 toString in class Entity
 - getDefinitionId
```
public String getDefinitionId()
```
 Returns the definition id of the entity. The definition serves as the template to create the actual entity instance.
 
 Returns:
 
 the underlying definition of the entity
 - getState
```
public String getState()
```
 Returns the current state of the entity.
 
 Returns:
 
 the state of the entity
 - getSubState
```
public String getSubState()
```
 Returns the current sub state of the entity.
 
 Returns:
 
 the sub state of the entity
 - getVariables
```
@Deprecated
public final List<Variable> getVariables()
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariables() method instead and recheck where you store the variables
 
 Returns the variables of the entity.
 
 Returns:
 
 the variables of the entity
 - getVariables
```
@Deprecated
public final List<Variable> getVariables(com.google.common.base.Predicate<Variable> predicate)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariables(Predicate) method instead and recheck where you store the variables
 
 Returns the variables of the entity, filtered by the given predicate.
 
 Parameters:
 
 predicate - the predicate to filter by
 
 Returns:
 
 the variables of the entity
 - getVariablesMap
```
@Deprecated
public final Map<String,Object> getVariablesMap()
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariablesMap() method instead and recheck where you store the variables
 
 Returns the variables of the entity as name/value pairs. In case of name clashes, variables closer to this entity have precedence.
 
 Returns:
 
 the variables map of the entity
 - getVariablesMap
```
@Deprecated
public final Map<String,Object> getVariablesMap(com.google.common.base.Predicate<Variable> predicate)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariablesMap(Predicate) method instead and recheck where you store the variables
 
 Returns the variables of the entity as name/value pairs, filtered by the given predicate.
 
 Parameters:
 
 predicate - the predicate to filter by
 
 Returns:
 
 the filtered variables map of the entity
 - getVariable
```
@Deprecated
public Variable getVariable(String name)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariable(String) method instead and recheck where you store the variables
 
 Returns the variable with the given name. In case of name clashes, variables closer to this entity have precedence.
 
 Parameters:
 
 name - the name of the variable to return
 
 Returns:
 
 the variable
 - getVariableValue
```
@Deprecated
public final Object getVariableValue(String name)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(String) method instead and recheck where you store the variables
 
 Returns the value of the variable with the given name. In case of name clashes, variables closer to this entity have precedence.
 
 Parameters:
 
 name - the name of the variable whose value to return
 
 Returns:
 
 the variable value
 - getVariableValue
```
@Deprecated
public final <T> T getVariableValue(String name,
 Class<T> expectedType)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(String, Class) method instead and recheck where you store the variables
 
 Returns the value of the variable with the given name, cast to the expected type.
 
 Type Parameters:
 
 T - the type of the id/externalId
 
 Parameters:
 
 name - the name of the variable whose value to return
 
 expectedType - the expected type of the variable value
 
 Returns:
 
 the variable value
 - getVariableValue
```
@Deprecated
public final <T> T getVariableValue(String name,
 com.google.common.reflect.TypeToken<T> expectedType)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(String, Class) method instead and recheck where you store the variables
 
 Returns the value of the variable with the given name, cast to the expected type. Note: using this TypeToken based API is useful when working with parameterized values.
 
 Type Parameters:
 
 T - the type of the id/externalId
 
 Parameters:
 
 name - the name of the variable whose value to return
 
 expectedType - the expected type of the variable value
 
 Returns:
 
 the variable value
 - getVariableValue
```
@Deprecated
public final <V,W> V getVariableValue(ValueAccessor<V> variableAccessor)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(ValueAccessor) method instead and recheck where you store the variables
 
 Returns the value of the variable with the name defined by the variable accessor, deserialized and cast to the type expected by the variable accessor.
 
 Type Parameters:
 
 V - the expected transient type of the named value
 
 W - the expected persisted type of the named value
 
 Parameters:
 
 variableAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type
 
 Returns:
 
 the variable value
 - hasVariable
```
@Deprecated
public boolean hasVariable(String name)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalVariable(String) method instead and recheck where you store the variables
 
 Returns true if the entity has a variable with the given name.
 
 Parameters:
 
 name - the name of the variable
 
 Returns:
 
 true if the entity has a variable with the given name
 - hasVariable
```
@Deprecated
public boolean hasVariable(ValueAccessor<?> variableAccessor)
```
 Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalVariable(ValueAccessor) method instead and recheck where you store the variables
 
 Returns true if the entity has a variable with the name of the given variable accessor.
 
 Parameters:
 
 variableAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type
 
 Returns:
 
 true if the entity has a variable with the name of the given variable accessor
 - getLocalVariables
```
public final List<Variable> getLocalVariables()
```
 Returns the local variables of the entity.
 
 Returns:
 
 the local variables of the entity
 - getLocalVariables
```
public final List<Variable> getLocalVariables(com.google.common.base.Predicate<Variable> predicate)
```
 Returns the local variables of the entity, filtered by the given predicate.
 
 Parameters:
 
 predicate - the predicate to filter by
 
 Returns:
 
 the filtered local variables of the entity
 - getLocalVariablesMap
```
public final Map<String,Object> getLocalVariablesMap()
```
 Returns the local variables of the entity as name/value pairs.
 
 Returns:
 
 the local variables map of the entity
 - getLocalVariablesMap
```
public final Map<String,Object> getLocalVariablesMap(com.google.common.base.Predicate<Variable> predicate)
```
 Returns the local variables of the entity as name/value pairs, filtered by the given predicate.
 
 Parameters:
 
 predicate - the predicate to filter by
 
 Returns:
 
 the filtered local variables map of the entity
 - getLocalVariable
```
public Variable getLocalVariable(String name)
```
 Returns the local variable with the given name.
 
 Parameters:
 
 name - the name of the local variable to return
 
 Returns:
 
 the variable
 - getLocalVariableValue
```
public final Object getLocalVariableValue(String name)
```
 Returns the value of the local variable with the given name.
 
 Parameters:
 
 name - the name of the local variable whose value to return
 
 Returns:
 
 the variable value
 - getLocalVariableValue
```
public final <T> T getLocalVariableValue(String name,
 Class<T> expectedType)
```
 Returns the value of the local variable with the given name, cast to the expected type.
 
 Type Parameters:
 
 T - the type of the id/externalId
 
 Parameters:
 
 name - the name of the local variable whose value to return
 
 expectedType - the expected type of the variable value
 
 Returns:
 
 the variable value
 - getLocalVariableValue
```
public final <T> T getLocalVariableValue(String name,
 com.google.common.reflect.TypeToken<T> expectedType)
```
 Returns the value of the local variable with the given name, cast to the expected type. Note: using this TypeToken based API is useful when working with parameterized values.
 
 Type Parameters:
 
 T - the type of the id/externalId
 
 Parameters:
 
 name - the name of the local variable whose value to return
 
 expectedType - the expected type of the variable value
 
 Returns:
 
 the variable value
 - getLocalVariableValue
```
public final <V,W> V getLocalVariableValue(ValueAccessor<V> variableAccessor)
```
 Returns the value of the local variable with the name defined by the variable accessor, deserialized and cast to the type expected by the variable accessor.
 
 Type Parameters:
 
 V - the expected transient type of the named value
 
 W - the expected persisted type of the named value
 
 Parameters:
 
 variableAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type
 
 Returns:
 
 the variable value
 - hasLocalVariable
```
public boolean hasLocalVariable(String name)
```
 Returns true if the entity has a local variable with the given name.
 
 Parameters:
 
 name - the name of the variable
 
 Returns:
 
 true if the entity has a local variable with the given name
 - hasLocalVariable
```
public boolean hasLocalVariable(ValueAccessor<?> variableAccessor)
```
 Returns true if the entity has a local variable with the name of the given variable accessor.
 
 Parameters:
 
 variableAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type
 
 Returns:
 
 true if the entity has a local variable with the name of the given variable accessor
 - getStateUpdateTime
```
public Instant getStateUpdateTime()
```
 Returns the time the entity state was last updated.
 
 Returns:
 
 the last update time of the entity’s state
 - getSubStateUpdateTime
```
public Instant getSubStateUpdateTime()
```
 Returns the time the entity sub state was last updated.
 
 Returns:
 
 the last update time of the entity’s sub state

Class AnyWorkObject

Nested Class Summary

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

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

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

VARIABLE_DELETED_VALUE

Method Detail

builder

builder

getOwnerId

getAssigneeId

getInitialAssigneeId

getPreviousAssigneeId

getAssignedGroupId

getInitialAssignedGroupId

getPreviousAssignedGroupId

getCandidateUserIds

getCandidateGroupIds

getPriority

getResubmissionTime

getDueTime

getAssigneeIdUpdateTime

getAssignedGroupIdUpdateTime

getPath

getRootId

hasParent

getParentId

isActive

isCompleted

isInterrupted

toString

getDefinitionId

getState

getSubState

getVariables

getVariables

getVariablesMap

getVariablesMap

getVariable

getVariableValue

getVariableValue

getVariableValue

getVariableValue

hasVariable

hasVariable

getLocalVariables

getLocalVariables

getLocalVariablesMap

getLocalVariablesMap

getLocalVariable

getLocalVariableValue

getLocalVariableValue

getLocalVariableValue

getLocalVariableValue

hasLocalVariable

hasLocalVariable

getStateUpdateTime

getSubStateUpdateTime