Interface AgentGroupModifier
- All Superinterfaces:
GroupModifier<AgentGroup>
,Modifier<AgentGroup>
- Since:
- 10.0.108
-
Method Summary
Modifier and TypeMethodDescriptionaddAssignedCategories
(Category... categories) Assign the group to the passed categories.Get an unmodifiable view of the current user assignments which are held in thisAgentGroupModifier
.removeAssignedCategories
(Category... categories) Remove the assignment of the group to the passed categories.removeUserAssignments
(User... users) Remove the assignment of the group to the passed users.setDescription
(String description) Change the description of the associatedGroup
.Change the name of the associatedGroup
.setParent
(SystemGroup parent) Change the parent system group of the associatedGroup
.setUserAssignment
(User user, Optional<Integer> skill) Assign the user to the group with an optional individual skill or change the individual skill of an already assigned user in this group.Methods inherited from interface com.novomind.ecom.api.imail.routing.persistence.GroupModifier
getAssignedCategories, getDescription, getName, getParent, validateDescription, validateName, validateParent
-
Method Details
-
setName
Description copied from interface:GroupModifier
Change the name of the associated
Group
.The change is applied after the
Modifier.write()
method is called.- Specified by:
setName
in interfaceGroupModifier<AgentGroup>
- Parameters:
name
- the new name as String- Returns:
- the
GroupModifier
- Throws:
ValidationException
- if the new name is invalid
-
setDescription
Description copied from interface:GroupModifier
Change the description of the associated
Group
.The change is applied after the
Modifier.write()
method is called.- Specified by:
setDescription
in interfaceGroupModifier<AgentGroup>
- Parameters:
description
- the new description as String- Returns:
- the
GroupModifier
- Throws:
ValidationException
- if the new description is invalid
-
addAssignedCategories
Description copied from interface:GroupModifier
Assign the group to the passed categories.
The change is applied after the
Modifier.write()
method is called.- Specified by:
addAssignedCategories
in interfaceGroupModifier<AgentGroup>
- Parameters:
categories
- the categories the group should be assigned to- Returns:
- the
GroupModifier
- Throws:
ValidationException
- if a category is null
-
removeAssignedCategories
Description copied from interface:GroupModifier
Remove the assignment of the group to the passed categories.
The change is applied after the
Modifier.write()
method is called.- Specified by:
removeAssignedCategories
in interfaceGroupModifier<AgentGroup>
- Parameters:
categories
- the categories for which the assignment should be removed- Returns:
- the
GroupModifier
- Throws:
ValidationException
- if a category is null
-
setParent
Description copied from interface:GroupModifier
Change the parent system group of the associated
Group
.The change is applied after the
Modifier.write()
method is called.- Specified by:
setParent
in interfaceGroupModifier<AgentGroup>
- Parameters:
parent
- the new parent system group- Returns:
- the
GroupModifier
- Throws:
ValidationException
- if the new parent is invalid
-
getUserAssignments
Set<UserAgentGroupAssignment> getUserAssignments()Get an unmodifiable view of the current user assignments which are held in thisAgentGroupModifier
.- Returns:
- the current user assignments as an unmodifiable set
- Since:
- 10.0.108
-
setUserAssignment
Assign the user to the group with an optional individual skill or change the individual skill of an already assigned user in this group.
The change is applied after the
Modifier.write()
method is called.- Parameters:
user
- the user to assign to this group or the user the skill should be changed forskill
- the individual skill the user should have in this agent group or an emptyOptional
to use the default user skill- Returns:
- the
AgentGroupModifier
- Throws:
ValidationException
- if the user is null or not assignable- Since:
- 10.0.108
-
removeUserAssignments
Remove the assignment of the group to the passed users.
The change is applied after the
Modifier.write()
method is called.- Parameters:
users
- the users for which the assignment should be removed- Returns:
- the
AgentGroupModifier
- Throws:
ValidationException
- if an user is null- Since:
- 10.0.108
-