public interface InternalWorklistItem extends WorklistItem
See WorklistItem for more information about the relationship
between InternalWorklistItem, AdministrativeWorklistItem and
ClientWorklistItem.
WorklistItem.Delegation| Modifier and Type | Field and Description |
|---|---|
static long |
serialVersionUID
Generated ID for serialisation.
|
static java.lang.String |
WORKLIST_ITEM_CHANGED
A user attribute to indicate the internal logic of an internal worklist
that a worklist item has changed even if the property tracker indicates no
changes.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addedToWorklist(java.util.UUID worklistID)
Notifies this item that it has been added to the designated worklist.
|
void |
addedToWorklist(java.util.UUID worklistID,
QualifiedAgent originator)
Notifies this item that it has been added to the designated worklist.
|
void |
delegateTo(java.util.Set<QualifiedAgent> delegationRecipients,
QualifiedAgent delegator,
java.lang.String comment)
Notifies this item that it has been delegated to the designated agents.
|
void |
enquireItem(Enquiry enquiry)
Sets this item in enquiry mode which logs the designated enquiry internally
for information purpose.
|
void |
escalated()
Notifies this item that it has been escalated once more.
|
ParameterDataContext |
getAttachedDataContext()
Gets the data context which provides the values of attached data elements.
|
int |
getAvailableStateDelegationIndex()
Gets the last position in the delegation history that has been set when
calling
storeCurrentState(boolean). |
java.util.UUID[] |
getAvailableStateWorklistIDs()
Gets the IDs of the worklists this item has been when calling
storeCurrentState(boolean). |
java.lang.String |
getDelegationHandlingProcedureID()
The ID of the delegation handling procedure.
|
java.util.List<WorklistItem.Delegation> |
getDelegationHistory()
Gets the delegation history of this item, that is, the agents who have
delegated this item and the corresponding delegation comments.
|
java.lang.String |
getDistributionHandlingProcedureID()
The ID of the distribution handling procedure.
|
java.util.List<Enquiry> |
getEnquiryStack()
Gets the enquiry stack of this item, that is, the agent who has started the
enquiry, the recipients and the question asked.
|
java.lang.String |
getEscalationHandlingProcedureID()
The ID of the escalation handling procedure for the due date.
|
java.util.Set<IndividualWorklistItemSettings> |
getIndividualWorklistItemSettings()
Returns a set of all individual worklist item settings which have been set
for this worklist item.
|
IndividualWorklistItemSettings |
getIndividualWorklistItemSettings(java.util.UUID worklistID)
Returns the individual item settings which are stored for the given
worklist identified by its unique id.
|
java.lang.String |
getStaffAssignmentRule()
Returns the staff assignment rule, with which this item has been
distributed before any delegation has taken place (if at all).
|
java.util.Set<QualifiedAgent> |
getSubstitutionFrom(java.util.UUID worklistID)
Returns the agents being the cause for having this item in the designated
worklist.
|
java.util.Map<java.util.UUID,java.util.Set<QualifiedAgent>> |
getSubstitutionOriginators()
Gets the substitution originators for all worklists that this item
was substituted to.
|
java.util.UUID[] |
getWorklistIDs()
Returns the UUIDs of all worklists, this item belongs to unless it is
suppressed.
|
java.util.UUID[] |
getWorklistIds(boolean inclSuppr)
Gets the UUIDs of all worklists, optionally including suppressed worklist
items.
|
boolean |
hasIndividualWorklistItemSettings(java.util.UUID worklistId)
Gets whether the worklist with the designated ID has individual worklist
item settings.
|
boolean |
isAboutToBeSuppressed()
Gets whether this worklist item is about to be suppressed.
|
boolean |
isSuppressed()
Gets whether this worklist item and the corresponding activity is
temporarily suppressed.
|
void |
removeAvailableState()
Removes the available state, that is the worklist IDs this item has been
after it got available.
|
void |
removeDelegations()
Removes all delegations, that is all data related to a delegation.
|
void |
removedFromWorklist(java.util.UUID worklistID)
Notifies this item that it has been removed from the designated worklist.
|
java.util.Set<QualifiedAgent> |
removeSubstitution(java.util.UUID worklistId)
Removes the substitution of this worklist item for the designated worklist.
|
void |
replyEnquiry(Enquiry reply)
Replies to the current enquiry, that is, the current enquiry is removed and
the designated reply is provided to the corresponding originator.
|
void |
restoreAvailableState()
Restores the worklists this item belongs to the state right before the
state changed away from
AVAILABLE or right after the item
has been delegated. |
void |
setAboutToBeSuppressed()
Sets this worklist item is about to be suppressed.
|
void |
setAssignedAgent(QualifiedAgent agent)
Sets the agent to the designated agent when this item is assigned.
|
void |
setAssignmentDate(long timestamp)
Sets the timestamp when this item has been assigned to the current user and
therefore the current worklist.
|
void |
setAttachedDataContext(ParameterDataContext dataContext)
Sets the data context which provides the values of attached data elements.
|
void |
setDescription(java.lang.String description)
Set the description of the item.
|
void |
setDueDate(long timestamp)
Sets the timestamp as absolute date when this item has to be finished.
|
void |
setEscalation(long timestamp,
java.lang.String escalationHandlingProcedureID)
Sets the escalation which includes the timestamp as absolute date and the
escalation handling procedure.
|
void |
setPluginData(PluginData pluginData)
Sets the data of the designated plugin using an internal extension point.
|
void |
setPluginData(java.lang.String extPointId,
PluginData pluginData)
Sets the data of the designated plugin for the designated extension point.
|
void |
setPriority(int priority)
Sets the priority of the item as a simple integer.
|
void |
setProcessInstanceName(java.lang.String instName)
Set the process instance name of the item.
|
void |
setState(WorklistConstants.WorklistItemState state)
Sets the state of this worklist item (e.g. if it is started or available).
|
void |
setSuppressed(boolean suppressed)
Sets this worklist item to (not) suppressed indicating that the
corresponding activity cannot be started, (un-)selected or resumed.
|
void |
setTitle(java.lang.String title)
Sets the title of the item.
|
void |
storeCurrentState(boolean delegated)
Stores the current state of the worklists this item currently belongs to
(including delegation target worklists).
|
boolean |
updateIndividualWorklistItemSettings(IndividualWorklistItemSettings itemSettings)
Updates the individual item settings by taking them from the given
settings.
|
equals, getActivationDate, getActivityReference, getAssignedAgent, getAssignmentDate, getComplexity, getCurrentDelegation, getCurrentDelegationLevel, getCurrentEnquiry, getCurrentEscalationLevel, getDescription, getDueDate, getEscalationDate, getGroupId, getIconID, getID, getPriority, getProcessInstanceName, getProcessTemplateName, getProcessTemplateVersion, getProcessType, getRepliedEnquiry, getState, getTitlegetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuegetPluginData, getPluginDatas, getSupportedPluginsstatic final long serialVersionUID
static final java.lang.String WORKLIST_ITEM_CHANGED
java.util.UUID[] getWorklistIDs()
java.util.UUID[] getWorklistIds(boolean inclSuppr)
getWorklistIDs() when excluding suppression.inclSuppr - Whether to also get the worklist IDs this item belongs to
when promoted. This flag is irrelevant if this item is not
suppressed.void addedToWorklist(java.util.UUID worklistID)
getWorklistIDs()).worklistID - The worklist this item has been added to.void addedToWorklist(java.util.UUID worklistID,
QualifiedAgent originator)
getWorklistIDs()).worklistID - The worklist this item has been added to.originator - The originator (absentee) of the substitution to this worklist.void removedFromWorklist(java.util.UUID worklistID)
getWorklistIDs()).worklistID - The worklist this item has been removed from.java.util.Set<QualifiedAgent> removeSubstitution(java.util.UUID worklistId)
null. worklistId - The worklist this item is on as substitution.null in case this worklist item is not on the the designated worklist or
it is on the worklist but not from a substitution.java.util.Set<QualifiedAgent> getSubstitutionFrom(java.util.UUID worklistID)
worklistID - void setTitle(java.lang.String title)
title - The title of this worklist item.void setDescription(java.lang.String description)
description - The description of this worklist item.void setProcessInstanceName(java.lang.String instName)
instName - The process instance name of this worklist item.java.lang.String getStaffAssignmentRule()
boolean isSuppressed()
boolean isAboutToBeSuppressed()
suppressed shortly.void setState(WorklistConstants.WorklistItemState state)
state - The new state of this worklist item.void setAboutToBeSuppressed()
void setSuppressed(boolean suppressed)
suppressed - Whether to (un-)suppress this worklist item.void setPriority(int priority)
WorklistConstants.Prioritypriority - The priority of the item.void setAssignmentDate(long timestamp)
timestamp - The time when this item has been (re-)assigned to the
corresponding user.void setEscalation(long timestamp,
java.lang.String escalationHandlingProcedureID)
timestamp - The due date (absolute) when this item is escalated.escalationHandlingProcedureID - The ID of the escalation handling
procedurevoid setDueDate(long timestamp)
escalation time. Use a negative if
this item has no due date.timestamp - The due date (absolute) when this item has to be finished
for displaying to the user.void setAssignedAgent(QualifiedAgent agent)
agent - The agent to whom this item has been assigned or
null in case this item is unassigned again.java.lang.String getEscalationHandlingProcedureID()
EscalationHandling.getID()java.lang.String getDistributionHandlingProcedureID()
DistributionHandling.getID()java.lang.String getDelegationHandlingProcedureID()
DelegationHandling.getID()void escalated()
escalation level by 1.void delegateTo(java.util.Set<QualifiedAgent> delegationRecipients, QualifiedAgent delegator, java.lang.String comment)
getStaffAssignmentRule(),
WorklistItem.getCurrentDelegationLevel(),
WorklistItem.getCurrentDelegation()).delegation level by 1.delegationRecipients - The agents to whom this item is delegated.delegator - The agent who delegates this worklist item.comment - A comment for the delegator why this item has been
delegated. This is optional and may therefore be null.java.util.List<WorklistItem.Delegation> getDelegationHistory()
void removeDelegations()
java.util.List<Enquiry> getEnquiryStack()
void enquireItem(Enquiry enquiry)
reply.enquiry - The enquiry which has been made for this item for
information purpose.WorklistItem.getCurrentEnquiry()void replyEnquiry(Enquiry reply)
null is provided, the current reply and the topmost enquiry
will be dropped.reply - The enquiry-object containing the corresponding originator who
will receive the reply as well as the reply. If null
is provided, the current reply and the topmost enquiry will be
dropped.ParameterDataContext getAttachedDataContext()
void setAttachedDataContext(ParameterDataContext dataContext)
dataContext - The data context containing data values attached to this
EBP which allow for filtering and ordering worklists.void storeCurrentState(boolean delegated)
AVAILABLE)
or after changing the worklists when delegating. If an item is reset, this
state needs to be restored.delegated - Whether the storing is done due to a delegation (or due to
a state change otherwise).void restoreAvailableState()
AVAILABLE or right after the item
has been delegated. The state has to be stored before appropriately and it
will be removed after it has been restored. If the state has not been
stored, this operation does nothing.storeCurrentState(boolean)void removeAvailableState()
java.util.UUID[] getAvailableStateWorklistIDs()
storeCurrentState(boolean). This allows to restore the worklists
to the state, when the state changed away from AVAILABLE.AVAILABLE. The array will be empty if it has not
been in a worklist and NULL if no state has been
stored yet or since the last restoring.int getAvailableStateDelegationIndex()
storeCurrentState(boolean). This allows to restore the
delegation history to the state, when the state changed away from
AVAILABLE.AVAILABLE. The index will be -1 if there has not
been a delegation history and Integer.MIN_VALUE if
no state has been stored yet or since the last restoring.boolean hasIndividualWorklistItemSettings(java.util.UUID worklistId)
worklistId - The ID of the worklist to check for having individual
worklist item settings.IndividualWorklistItemSettings getIndividualWorklistItemSettings(java.util.UUID worklistID)
worklistID - The (unique) ID of the worklist to get the individual
item settings.boolean updateIndividualWorklistItemSettings(IndividualWorklistItemSettings itemSettings)
itemSettings - The settings to read the individual settings from.java.util.Set<IndividualWorklistItemSettings> getIndividualWorklistItemSettings()
void setPluginData(PluginData pluginData)
pluginData - The plugin data (including the name of the plugin) to set the data of.void setPluginData(java.lang.String extPointId,
PluginData pluginData)
extPointId - The ID of the extension point of the plugin.pluginData - The plugin data (including the name of the plugin) to set the data of.java.util.Map<java.util.UUID,java.util.Set<QualifiedAgent>> getSubstitutionOriginators()