Interface IndividualWorklistItemSettings
-
- All Superinterfaces:
PluginDataContainer
,Serializable
,UserAttributeContainer
- All Known Subinterfaces:
ClientWorklistItem
public interface IndividualWorklistItemSettings extends UserAttributeContainer, PluginDataContainer, Serializable
This interface defines the individual settings that a user may have per client worklist item (which also clearly associates it with a single worklist,getWorklistID()
). Some of these settings override corresponding properties from an internal worklist item, like title, description or priority.This interface is extended by
ClientWorklistItem
and may also be implemented by thede.aristaflow.adept2.core.worklistmanager
to internally store these settings.
-
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
Generated ID for serialisation.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getIndividualDescription()
Gets the individual description of the item by the user.long
getIndividualDueDate()
Gets the individual due date of this client worklist item.long
getIndividualEscalationDate()
Returns the individual timestamp as absolute date when this item is escalated.String
getIndividualEscalationHandlingProcedureID()
Gets the ID of the escalation handling procedure set for the current individual escalation date.Map<String,PluginData>
getIndividualPluginDatas()
Returns a map from the ID of a plug-in to the plug-in data objects.int
getIndividualPriority()
Gets the individual priority of this client worklist item.Map<String,Set<String>>
getIndividualSupportedPlugins()
Returns a map from the ID of an extension point to the IDs of the plug-ins within the extension point.String
getIndividualTitle()
Gets the individual title of the item by the user.Map<String,String>
getIndividualUserAttributes()
Returns all user attributes as map, the key of the map is the name of the attribute.long
getResubmissionDate()
Gets the date when the worklist item will be resubmitted, that is, it will reappear in the worklist.UUID
getWorklistID()
Gets the worklist's ID in whose context these individual settings apply.void
setIndividualDescription(String individualDescription)
Sets the individual description of the item by the user.void
setIndividualDueDate(long individualDueDate)
Sets the individual due date of this client worklist item and the corresponding escalation handling procedure.void
setIndividualEscalation(long timestamp, String escalationHandlingProcedureID)
Sets the escalation which includes the timestamp as absolute date and the escalation handling procedure.void
setIndividualPluginData(PluginData pluginData)
Sets the data of the designated plugin.void
setIndividualPriority(int individualPriority)
Sets the individual priority of this client worklist item.void
setIndividualTitle(String title)
Sets the individual title of the item by the user.void
setResubmissionDate(long resubmissionDate)
Sets the date when the worklist item will be resubmitted, that is it is shown in the normal worklist again.-
Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer
getPluginData, getPluginDatas, getSupportedPlugins
-
Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer
getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
Generated ID for serialisation.- See Also:
- Constant Field Values
-
-
Method Detail
-
getWorklistID
UUID getWorklistID()
Gets the worklist's ID in whose context these individual settings apply.- Returns:
- The worklist's ID in whose context these individual settings apply.
-
getIndividualTitle
String getIndividualTitle()
Gets the individual title of the item by the user.- Returns:
- The individual title of the item by the user or
null
if no individual title set.
-
setIndividualTitle
void setIndividualTitle(String title)
Sets the individual title of the item by the user.- Parameters:
title
- The individual title of this worklist item.
-
getIndividualDescription
String getIndividualDescription()
Gets the individual description of the item by the user.- Returns:
- The individual description of the item by the user.
-
setIndividualDescription
void setIndividualDescription(String individualDescription)
Sets the individual description of the item by the user.- Parameters:
individualDescription
- The individual description of this worklist item.
-
getIndividualPriority
int getIndividualPriority()
Gets the individual priority of this client worklist item.- Returns:
- The individual priority value of the user.
-
setIndividualPriority
void setIndividualPriority(int individualPriority)
Sets the individual priority of this client worklist item. Use a negative number to disable the individual priority.- Parameters:
individualPriority
- The individual priority value of the user.
-
getIndividualDueDate
long getIndividualDueDate()
Gets the individual due date of this client worklist item. A 0 means there is no individual due date set.- Returns:
- The individual due date of the user.
-
getIndividualEscalationHandlingProcedureID
String getIndividualEscalationHandlingProcedureID()
Gets the ID of the escalation handling procedure set for the current individual escalation date. This may be used for displaying icons in the worklist. This method will returnnull
if no individual escalation date is set.- Returns:
- The ID (name) of the escalation handling procedure set for the
current individual escalation date or
null
if no individual escalation date is set.
-
setIndividualDueDate
void setIndividualDueDate(long individualDueDate)
Sets the individual due date of this client worklist item and the corresponding escalation handling procedure. This is executed in case the due date is reached. If the escalation handling procedure is unknown, it will be ignored.- Parameters:
individualDueDate
- The individual due date of the user. Use 0 to deactivate the individual due date. A negative value will be interpreted as relative date.
-
getResubmissionDate
long getResubmissionDate()
Gets the date when the worklist item will be resubmitted, that is, it will reappear in the worklist. Otherwise it is hidden from the normal worklist and only displayed in a special worklist containing only such delayed items. A 0 means there is no resubmission date set.- Returns:
- The resubmission date of this worklist item that is the date it will be displayed again in the normal worklist.
-
setResubmissionDate
void setResubmissionDate(long resubmissionDate)
Sets the date when the worklist item will be resubmitted, that is it is shown in the normal worklist again.
The resubmission may not be set forSTARTED
worklist items but for all other worklist item states. However a started worklist item may be deactivated (set resubmission to a negative value).- Parameters:
resubmissionDate
- The date when the worklist item will be displayed again in the normal worklist. Use 0 to deactivate the resubmission date. A negative value will be interpreted as relative date.
-
getIndividualEscalationDate
long getIndividualEscalationDate()
Returns the individual timestamp as absolute date when this item is escalated. When escalating, the escalation date (and maybe also the due date) will usually be adapted accordingly.
If 0 is returned, this item has no escalation date.- Returns:
- The escalation date (absolute) when this item is subject of escalation.
-
setIndividualEscalation
void setIndividualEscalation(long timestamp, String escalationHandlingProcedureID)
Sets the escalation which includes the timestamp as absolute date and the escalation handling procedure. Normally escalation takes place some time before the due date, for instance, after 80% of the time span between activation date and due date have passed.
Use 0 and null as ID if this item has no escalation date.- Parameters:
timestamp
- The due date (absolute) when this item is escalated.escalationHandlingProcedureID
- The ID of the escalation handling procedure
-
getIndividualUserAttributes
Map<String,String> getIndividualUserAttributes()
Returns all user attributes as map, the key of the map is the name of the attribute.- Returns:
- A map with all user defined attributes.
-
getIndividualSupportedPlugins
Map<String,Set<String>> getIndividualSupportedPlugins()
Returns a map from the ID of an extension point to the IDs of the plug-ins within the extension point.- Returns:
- An unmodifiable map from extension point IDs to plug-in IDs.
-
getIndividualPluginDatas
Map<String,PluginData> getIndividualPluginDatas()
Returns a map from the ID of a plug-in to the plug-in data objects.- Returns:
- An unmodifiable map from plug-in IDs to plug-in data objects.
-
setIndividualPluginData
void setIndividualPluginData(PluginData pluginData)
Sets the data of the designated plugin.- Parameters:
pluginData
- The plugin data (including the name of the plugin) to set the data of.
-
-