public interface WorklistUpdateConfiguration extends UserAttributeContainer, java.io.Serializable
The configuration will be used server side (e.g. for push-modes), as well as on client side (e.g. for poll-modes).
It is possible to specify the configuration concerning updates per-priority. This allows e.g. to receive urgent items by PUSH, less important items by POLL. As soon as a worklist item has a high enough priority to be pushed, all former updates are also sent. This allows provides for consistent revisions of client and server worklists. Otherwise some revisions (with low priority items) would be missing.
| Modifier and Type | Field and Description |
|---|---|
static long |
serialVersionUID
Generated ID for serialisation.
|
| Modifier and Type | Method and Description |
|---|---|
long |
getUpdateInterval(int priority)
Get the update interval in case of
PUSH in milliseconds for
the designated priority. |
int[] |
getUpdateIntervalThresholds()
An array of priority values which are thresholds of the update intervals,
sorted by priority.
|
int |
getUpdateModeThreshold()
The priority threshold that determines the update mode.
|
boolean |
getUpdatesIncrementally()
Whether the pushed updates for the worklist should be incremental updates,
that is, the updates are not transferred completely but as requested.
|
Filter |
getWorklistFilter()
Returns the filter applied on the worklist items or
null if no
filter is applied. |
getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuestatic final long serialVersionUID
int getUpdateModeThreshold()
PUSH,
priorities below the threshold in PULL. I.e. for a
pull-only mode use Integer.MAX_VALUE, if every update should be
pushed use 0.
Please refer to
WorklistConstants.Priority for
some default values.
long getUpdateInterval(int priority)
PUSH in milliseconds for
the designated priority. This allows for timed PUSH based
on the priority: Although a PUSH is configured for a specific
priority, the PUSH is not performed before the update interval
has elapsed.
Please refer to
WorklistConstants.Priority for
some default values.
priority - The priority for which to retrieve the push update
interval.int[] getUpdateIntervalThresholds()
PUSHed
updates, worklist items with a priority for PULL have an
infinite update interval. Therefore an empty array will be returned for
PULLed only.
Please refer to
WorklistConstants.Priority for
some default values.
PUSHed priorities or an
empty array if PULL is used only.boolean getUpdatesIncrementally()
RemoteIterators.Filter getWorklistFilter()
null if no
filter is applied.null if no
filter is applied