Package com.novomind.ecom.api.imail.routing.persistence

Interface AgentGroupModifier

All Superinterfaces:

GroupModifier<AgentGroup>, Modifier<AgentGroup>

public interface AgentGroupModifier
extends GroupModifier<AgentGroup>

Defines an API to modify an instance of type AgentGroup.

Since:

10.0.108

Method Summary

Modifier and Type	Method	Description
AgentGroupModifier	addAssignedCategories(Category... categories)	Assign the group to the passed categories.
Set<UserAgentGroupAssignment>	getUserAssignments()	Get an unmodifiable view of the current user assignments which are held in this AgentGroupModifier.
AgentGroupModifier	removeAssignedCategories(Category... categories)	Remove the assignment of the group to the passed categories.
AgentGroupModifier	removeUserAssignments(User... users)	Remove the assignment of the group to the passed users.
AgentGroupModifier	setDescription(String description)	Change the description of the associated Group.
AgentGroupModifier	setName(String name)	Change the name of the associated Group.
AgentGroupModifier	setParent(SystemGroup parent)	Change the parent system group of the associated Group.
AgentGroupModifier	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

Methods inherited from interface com.novomind.ecom.api.imail.routing.persistence.Modifier

delete, get, write

Method Details

setName

AgentGroupModifier setName(String name)
                    throws ValidationException

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 interface GroupModifier<AgentGroup>

Parameters:

name - the new name as String

Returns:

the GroupModifier

Throws:

ValidationException - if the new name is invalid

setDescription

AgentGroupModifier setDescription(String description)
                           throws ValidationException

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 interface GroupModifier<AgentGroup>

Parameters:

description - the new description as String

Returns:

the GroupModifier

Throws:

ValidationException - if the new description is invalid

addAssignedCategories

AgentGroupModifier addAssignedCategories(Category... categories)
                                  throws ValidationException

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 interface GroupModifier<AgentGroup>

Parameters:

categories - the categories the group should be assigned to

Returns:

the GroupModifier

Throws:

ValidationException - if a category is null

removeAssignedCategories

AgentGroupModifier removeAssignedCategories(Category... categories)
                                     throws ValidationException

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 interface GroupModifier<AgentGroup>

Parameters:

categories - the categories for which the assignment should be removed

Returns:

the GroupModifier

Throws:

ValidationException - if a category is null

setParent

AgentGroupModifier setParent(SystemGroup parent)
                      throws ValidationException

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 interface GroupModifier<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 this AgentGroupModifier.

Returns:

the current user assignments as an unmodifiable set

Since:

10.0.108

setUserAssignment

AgentGroupModifier setUserAssignment(User user,
 Optional<Integer> skill)
                              throws ValidationException

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 for

skill - the individual skill the user should have in this agent group or an empty Optional to use the default user skill

Returns:

the AgentGroupModifier

Throws:

ValidationException - if the user is null or not assignable

Since:

10.0.108

removeUserAssignments

AgentGroupModifier removeUserAssignments(User... users)
                                  throws ValidationException

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