WorkObjectValues (edoras one Java API (2.0.0))

Skip navigation links

edoras one Java API (2.0.0)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.edorasware.api.value.WorkObjectValues

```
public final class WorkObjectValues
extends Object
```
Defines constants and helper methods used for work object value access.

Field Summary

Fields
Modifier and Type	Field and Description
`static StringValue<String>`	`ASSIGNED_GROUP_ID` The work object assigned group ID.
`static TimestampValue<Instant>`	`ASSIGNED_GROUP_ID_UPDATE_TIME` The work object assigned group update time.
`static StringValue<String>`	`ASSIGNEE_ID` The work object assignee ID.
`static TimestampValue<Instant>`	`ASSIGNEE_ID_UPDATE_TIME` The work object assignee update time.
`static CandidateField`	`CANDIDATE_GROUP_IDS` The work object candidate group IDs.
`static CandidateField`	`CANDIDATE_USER_IDS` The work object candidate user IDs.
`static TimestampValue<Instant>`	`CREATION_TIME` The work object creation timestamp.
`static StringValue<String>`	`DEFINITION_ID` The work object definition ID.
`static StringValue<String>`	`DESCRIPTION` The work object description.
`static TimestampValue<Instant>`	`DUE_TIME` The work object due time.
`static StringValue<String>`	`EXTERNAL_ID` The work object external ID.
`static StringValue<String>`	`GLOBAL_ID` The work object global ID (unique only within a single tenant).
`static StringValue<String>`	`ID` The work object ID (unique everywhere).
`static StringValue<String>`	`INITIAL_ASSIGNED_GROUP_ID` The initial work object assigned group ID.
`static StringValue<String>`	`INITIAL_ASSIGNEE_ID` The initial work object assignee ID.
`static ValueAccessor<String>`	`MODIFICATION_CREATOR_ID` The ID of the user that created the work object.
`static ValueAccessor<String>`	`MODIFICATION_UPDATER_ID` The ID of the user that last updated the work object.
`static ValueAccessor<Long>`	`MODIFICATION_VERSION` The work object modification version.
`static StringValue<String>`	`NAME` The work object name.
`static StringValue<String>`	`OWNER_ID` The work object owner ID.
`static PathField`	`PATH` The work object path (should only be used when creating an in-memory work object).
`static StringValue<String>`	`PREVIOUS_ASSIGNED_GROUP_ID` The previous work object assigned group ID.
`static StringValue<String>`	`PREVIOUS_ASSIGNEE_ID` The previous work object assignee ID.
`static com.edorasware.api.value.internal.PriorityFieldImpl`	`PRIORITY` The work object priority.
`static StringValue<String>`	`PROVIDER_ID` The work object provider ID.
`static TimestampValue<Instant>`	`RESUBMISSION_TIME` The work object resubmission time.
`static com.edorasware.api.value.internal.StateField`	`STATE` The work object state.
`static TimestampValue<Instant>`	`STATE_UPDATE_TIME` The work object state update time.
`static StringValue<String>`	`SUB_STATE` The work object sub-state.
`static TimestampValue<Instant>`	`SUB_STATE_UPDATE_TIME` The work object sub-state update time.
`static StringValue<String>`	`TENANT_ID` The work object tenant ID.
`static StringValue<String>`	`TYPE` The work object type.
`static TimestampValue<Instant>`	`UPDATE_TIME` The work object update timestamp.
`static VariableOperand`	`VARIABLE` Operand that allows predicates to be built for arbitrary variable names/values.
`static Set<String>`	`WORK_OBJECT_FIELD_NAMES` A set of all field value names (corresponding to fields with special persistence behaviour).
`static Set<String>`	`WORK_OBJECT_RESERVED_VALUE_NAMES` A set of all reserved value names (corresponding to fields that should not be overwritten).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkValueType(String valueName, Object value)` Checks that the given value to be written to a work object has a valid type.
`static BooleanValue<Boolean>`	`newBooleanValue(String name)` Constructs a new boolean value accessor.
`static <T> BooleanValue<T>`	`newBooleanValue(String name, ValueConverter<T,Boolean> valueConverter)` Constructs a new boolean value accessor.
`static <T> ComplexValue<T>`	`newComplexValue(String name, com.google.common.reflect.TypeToken<T> valueTypeToken)` Constructs a new complex value (a list or map).
`static <T> ComplexValue<T>`	`newComplexValue(String name, ValueConverter<T,?> valueConverter)` Constructs a new complex value accessor for a list or map value.
`static NumberValue<Double>`	`newDoubleValue(String name)` Constructs a new double value accessor.
`static <T> NumberValue<T>`	`newDoubleValue(String name, ValueConverter<T,Double> valueConverter)` Constructs a new double value accessor.
`static <T> ComplexValue<List<T>>`	`newListValue(String name, Class<T> entryType)` Constructs a new list value accessor with a given entry type.
`static <T> ComplexValue<List<T>>`	`newListValue(String name, ValueConverter<T,?> valueConverter)` Constructs a new list value accessor with a given entry value converter.
`static NumberValue<Long>`	`newLongValue(String name)` Constructs a new long value accessor.
`static <T> NumberValue<T>`	`newLongValue(String name, ValueConverter<T,Long> valueConverter)` Constructs a new long value accessor.
`static <T> ComplexValue<Set<T>>`	`newSetValue(String name, Class<T> entryType)` Constructs a new set value accessor with a given entry type.
`static <T> ComplexValue<Set<T>>`	`newSetValue(String name, ValueConverter<T,?> valueConverter)` Constructs a new set value accessor with a given entry value converter.
`static StringValue<String>`	`newStringValue(String name)` Constructs a new string value accessor.
`static <T> StringValue<T>`	`newStringValue(String name, ValueConverter<T,String> valueConverter)` Constructs a new string value accessor.
`static TimestampValue<Instant>`	`newTimestampValue(String name)` Constructs a new timestamp value accessor.
`static <T> TimestampValue<T>`	`newTimestampValue(String name, ValueConverter<T,Instant> valueConverter)` Constructs a new timestamp value accessor.

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

Field Detail

VARIABLE

public static final VariableOperand VARIABLE

Operand that allows predicates to be built for arbitrary variable names/values.

Note

this can only be used for values that are known to be persisted as variables, and generating predicates from this operand is generally more verbose and error-prone than using specific value constants. It is provided for some rare use cases that require explicit control of the predicate being generated.

TYPE

public static final StringValue<String> TYPE

The work object type.

ID

public static final StringValue<String> ID

The work object ID (unique everywhere).

TENANT_ID

public static final StringValue<String> TENANT_ID

The work object tenant ID.

GLOBAL_ID
```
public static final StringValue<String> GLOBAL_ID
```
The work object global ID (unique only within a single tenant).

DEFINITION_ID

public static final StringValue<String> DEFINITION_ID

The work object definition ID.

PROVIDER_ID

public static final StringValue<String> PROVIDER_ID

The work object provider ID.

EXTERNAL_ID

public static final StringValue<String> EXTERNAL_ID

The work object external ID.

PATH
```
public static final PathField PATH
```
The work object path (should only be used when creating an in-memory work object).

STATE

public static final com.edorasware.api.value.internal.StateField STATE

The work object state.

STATE_UPDATE_TIME

public static final TimestampValue<Instant> STATE_UPDATE_TIME

The work object state update time.

SUB_STATE

public static final StringValue<String> SUB_STATE

The work object sub-state.

SUB_STATE_UPDATE_TIME

public static final TimestampValue<Instant> SUB_STATE_UPDATE_TIME

The work object sub-state update time.

OWNER_ID

public static final StringValue<String> OWNER_ID

The work object owner ID.

ASSIGNEE_ID

public static final StringValue<String> ASSIGNEE_ID

The work object assignee ID.

INITIAL_ASSIGNEE_ID

public static final StringValue<String> INITIAL_ASSIGNEE_ID

The initial work object assignee ID.

PREVIOUS_ASSIGNEE_ID

public static final StringValue<String> PREVIOUS_ASSIGNEE_ID

The previous work object assignee ID.

ASSIGNEE_ID_UPDATE_TIME

public static final TimestampValue<Instant> ASSIGNEE_ID_UPDATE_TIME

The work object assignee update time.

ASSIGNED_GROUP_ID

public static final StringValue<String> ASSIGNED_GROUP_ID

The work object assigned group ID.

INITIAL_ASSIGNED_GROUP_ID

public static final StringValue<String> INITIAL_ASSIGNED_GROUP_ID

The initial work object assigned group ID.

PREVIOUS_ASSIGNED_GROUP_ID

public static final StringValue<String> PREVIOUS_ASSIGNED_GROUP_ID

The previous work object assigned group ID.

ASSIGNED_GROUP_ID_UPDATE_TIME

public static final TimestampValue<Instant> ASSIGNED_GROUP_ID_UPDATE_TIME

The work object assigned group update time.

CANDIDATE_USER_IDS

public static final CandidateField CANDIDATE_USER_IDS

The work object candidate user IDs.

CANDIDATE_GROUP_IDS

public static final CandidateField CANDIDATE_GROUP_IDS

The work object candidate group IDs.

NAME

public static final StringValue<String> NAME

The work object name.

DESCRIPTION

public static final StringValue<String> DESCRIPTION

The work object description.

PRIORITY

public static final com.edorasware.api.value.internal.PriorityFieldImpl PRIORITY

The work object priority.

CREATION_TIME

public static final TimestampValue<Instant> CREATION_TIME

The work object creation timestamp.

UPDATE_TIME

public static final TimestampValue<Instant> UPDATE_TIME

The work object update timestamp.

RESUBMISSION_TIME

public static final TimestampValue<Instant> RESUBMISSION_TIME

The work object resubmission time.

DUE_TIME

public static final TimestampValue<Instant> DUE_TIME

The work object due time.

MODIFICATION_VERSION

public static final ValueAccessor<Long> MODIFICATION_VERSION

The work object modification version.

MODIFICATION_CREATOR_ID
```
public static final ValueAccessor<String> MODIFICATION_CREATOR_ID
```
The ID of the user that created the work object.

MODIFICATION_UPDATER_ID
```
public static final ValueAccessor<String> MODIFICATION_UPDATER_ID
```
The ID of the user that last updated the work object.

WORK_OBJECT_FIELD_NAMES
```
public static final Set<String> WORK_OBJECT_FIELD_NAMES
```
A set of all field value names (corresponding to fields with special persistence behaviour).

WORK_OBJECT_RESERVED_VALUE_NAMES
```
public static final Set<String> WORK_OBJECT_RESERVED_VALUE_NAMES
```
A set of all reserved value names (corresponding to fields that should not be overwritten).

Method Detail
- newStringValue
```
public static StringValue<String> newStringValue(String name)
```
  Constructs a new string value accessor.
  
  Parameters:
  
  name - the field name
  
  Returns:
  
  the new value accessor
- newStringValue
```
public static <T> StringValue<T> newStringValue(String name,
                                                ValueConverter<T,String> valueConverter)
```
  Constructs a new string value accessor.
  
  Parameters:
  
  name - the field name
  
  valueConverter - a value converter (allows a different value type to be used)
  
  Returns:
  
  the new value accessor
- newBooleanValue
```
public static BooleanValue<Boolean> newBooleanValue(String name)
```
  Constructs a new boolean value accessor.
  
  Parameters:
  
  name - the value name
  
  Returns:
  
  the new value accessor
- newBooleanValue
```
public static <T> BooleanValue<T> newBooleanValue(String name,
                                                  ValueConverter<T,Boolean> valueConverter)
```
  Constructs a new boolean value accessor.
  
  Parameters:
  
  name - the value name
  
  valueConverter - a value converter (allows a different value type to be used)
  
  Returns:
  
  the new value accessor
- newLongValue
```
public static NumberValue<Long> newLongValue(String name)
```
  Constructs a new long value accessor.
  
  Parameters:
  
  name - the value name
  
  Returns:
  
  the new value accessor
- newLongValue
```
public static <T> NumberValue<T> newLongValue(String name,
                                              ValueConverter<T,Long> valueConverter)
```
  Constructs a new long value accessor.
  
  Parameters:
  
  name - the value name
  
  valueConverter - a value converter (allows a different value type to be used)
  
  Returns:
  
  the new value accessor
- newDoubleValue
```
public static NumberValue<Double> newDoubleValue(String name)
```
  Constructs a new double value accessor.
  
  Parameters:
  
  name - the value name
  
  Returns:
  
  the new value accessor
- newDoubleValue
```
public static <T> NumberValue<T> newDoubleValue(String name,
                                                ValueConverter<T,Double> valueConverter)
```
  Constructs a new double value accessor.
  
  Parameters:
  
  name - the value name
  
  valueConverter - a value converter (allows a different value type to be used)
  
  Returns:
  
  the new value accessor
- newTimestampValue
```
public static TimestampValue<Instant> newTimestampValue(String name)
```
  Constructs a new timestamp value accessor.
  
  Parameters:
  
  name - the value name
  
  Returns:
  
  the new value accessor
- newTimestampValue
```
public static <T> TimestampValue<T> newTimestampValue(String name,
                                                      ValueConverter<T,Instant> valueConverter)
```
  Constructs a new timestamp value accessor.
  
  Parameters:
  
  name - the value name
  
  valueConverter - the value converter (allows a different value type to be used)
  
  Returns:
  
  the new value accessor
- newComplexValue
```
public static <T> ComplexValue<T> newComplexValue(String name,
                                                  com.google.common.reflect.TypeToken<T> valueTypeToken)
```
  Constructs a new complex value (a list or map).
  
  Parameters:
  
  name - the value name
  
  valueTypeToken - the type token describing the complex value type
  
  Returns:
  
  the new value accessor
- newComplexValue
```
public static <T> ComplexValue<T> newComplexValue(String name,
                                                  ValueConverter<T,?> valueConverter)
```
  Constructs a new complex value accessor for a list or map value.
  
  Parameters:
  
  name - the value name
  
  valueConverter - the value converter for the complex value type
  
  Returns:
  
  the new value accessor
- newSetValue
```
public static <T> ComplexValue<Set<T>> newSetValue(String name,
                                                   Class<T> entryType)
```
  Constructs a new set value accessor with a given entry type.
  
  Parameters:
  
  name - the value name
  
  entryType - the set entry type
  
  Returns:
  
  the new value accessor
- newSetValue
```
public static <T> ComplexValue<Set<T>> newSetValue(String name,
                                                   ValueConverter<T,?> valueConverter)
```
  Constructs a new set value accessor with a given entry value converter.
  
  Parameters:
  
  name - the value name
  
  valueConverter - the value converter for the set entries
  
  Returns:
  
  the new value accessor
- newListValue
```
public static <T> ComplexValue<List<T>> newListValue(String name,
                                                     Class<T> entryType)
```
  Constructs a new list value accessor with a given entry type.
  
  Parameters:
  
  name - the value name
  
  entryType - the list entry type
  
  Returns:
  
  the new value accessor
- newListValue
```
public static <T> ComplexValue<List<T>> newListValue(String name,
                                                     ValueConverter<T,?> valueConverter)
```
  Constructs a new list value accessor with a given entry value converter.
  
  Parameters:
  
  name - the value name
  
  valueConverter - the value converter for the list entries
  
  Returns:
  
  the new value accessor
- checkValueType
```
public static void checkValueType(String valueName,
                                  Object value)
```
  Checks that the given value to be written to a work object has a valid type.
  
  Parameters:
  
  valueName - the value name
  
  value - the value to be checked