public interface WorkObjectValueGetters
Defines methods used to access the work object values.
This interface provides both a completely generic value-based interface and separate convenience methods for common values to simplify the migration from legacy interfaces. The generic interface can be used to access all values of the work object (including those for which explicit convenience methods are provided).
Modifier and Type | Method and Description |
---|---|
String |
getAssignedGroupId()
Returns the work object assigned group ID.
|
String |
getAssigneeId()
Returns the work object assignee’s user ID.
|
Set<String> |
getCandidateGroupIds()
Returns the work object candidate group IDs.
|
Set<String> |
getCandidateUserIds()
Returns the work object candidate user IDs.
|
Instant |
getCreationTime()
Returns the time the entity was created.
|
String |
getDefinitionId()
Returns the definition ID of this work object.
|
String |
getDescription()
Returns the work object description.
|
Instant |
getDueTime()
Returns the work object due time.
|
String |
getExternalId()
Returns the external ID of this work object.
|
String |
getGlobalId()
Returns the global ID of this work object.
|
String |
getId()
Returns the ID of this work object.
|
String |
getModificationCreatorId()
Returns the ID of the user who created the work object.
|
String |
getName()
Returns the work object name.
|
String |
getOwnerId()
Returns the work object owner’s user ID.
|
Integer |
getPriority()
Returns the work object priority.
|
String |
getProviderId()
Returns the provider ID of this work object.
|
Instant |
getResubmissionTime()
Returns the work object resubmission time.
|
String |
getState()
Returns the work object state.
|
String |
getSubState()
Returns the work object sub-state.
|
String |
getTenantId()
Returns the tenant ID for this work object.
|
String |
getType()
Returns the work object type.
|
<T> T |
getValue(String name,
Class<T> requiredType)
Returns the value with the given name, cast to the expected type.
|
<V> V |
getValue(ValueAccessor<V> valueAccessor)
Returns the value defined by the accessor, de-serialized and cast to the expected type.
|
ValueMap |
getValues()
Returns a value map containing all values set on the work object.
|
boolean |
hasValue(String name)
Checks whether the work object has a value with the given name.
|
boolean |
hasValue(ValueAccessor<?> valueAccessor)
Checks whether the work object has a value with the given name.
|
ValueMap getValues()
Returns a value map containing all values set on the work object.
boolean hasValue(String name)
Checks whether the work object has a value with the given name.
Only values from this work object will be considered. Values inherited from parent work objects are ignored.
name
- the name of the value to checktrue
if a local value exists with the given nameboolean hasValue(ValueAccessor<?> valueAccessor)
Checks whether the work object has a value with the given name.
Only values from this work object will be considered. Values inherited from parent work objects are ignored.
valueAccessor
- the the accessor from which to derive the nametrue
if a local value exists with the given name<T> T getValue(String name, Class<T> requiredType)
Returns the value with the given name, cast to the expected type.
Only values from this work object will be considered. Values inherited from parent work objects are ignored.
T
- the required typename
- the name of the value whose value to returnrequiredType
- the required class of the value valueIllegalArgumentException
- if the value does not have the required type<V> V getValue(ValueAccessor<V> valueAccessor)
Returns the value defined by the accessor, de-serialized and cast to the expected type.
Only values from this work object will be considered. Values inherited from parent work objects are ignored.
V
- the expected value typevalueAccessor
- the accessor from which to derive the name, deserialize the value, and cast to the expected typeIllegalArgumentException
- if the value does not have the required typeString getType()
Returns the work object type.
String getId()
Returns the ID of this work object.
The ID is used to uniquely identify this particular work object instance.
String getProviderId()
Returns the provider ID of this work object.
The ID is used to identify the provider responsible for managing the work object.
String getExternalId()
Returns the external ID of this work object.
The external ID is used by the provider for managing the work object.
String getDefinitionId()
Returns the definition ID of this work object.
The definition ID references a definition that provides template information for the work object.
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.
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.
String getName()
Returns the work object name.
String getDescription()
Returns the work object description.
String getState()
Returns the work object state.
String getSubState()
Returns the work object sub-state.
String getOwnerId()
Returns the work object owner’s user ID.
String getAssigneeId()
Returns the work object assignee’s user ID.
String getAssignedGroupId()
Returns the work object assigned group ID.
Set<String> getCandidateUserIds()
Returns the work object candidate user IDs.
Set<String> getCandidateGroupIds()
Returns the work object candidate group IDs.
Integer getPriority()
Returns the work object priority.
Instant getResubmissionTime()
Returns the work object resubmission time.
Instant getDueTime()
Returns the work object due time.
String getModificationCreatorId()
Returns the ID of the user who created the work object.
Instant getCreationTime()
Returns the time the entity was created.
Copyright © 2010 - 2018 edorasware ag. All Rights Reserved.