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

Interface SystemGroupModifier

All Superinterfaces:

GroupModifier<SystemGroup>, Modifier<SystemGroup>

public interface SystemGroupModifier
extends GroupModifier<SystemGroup>

Defines an API to modify an instance of type SystemGroup.

Since:

10.0.108

Method Summary

Modifier and Type	Method	Description
SystemGroupModifier	addAssignedCategories(Category... categories)	Assign the group to the passed categories.
SystemGroupModifier	addAssignedPrivileges(GroupPrivilege... groupPrivileges)	Assign the passed privileges to the group.
SystemGroupModifier	addAssignedUsers(User... users)	Assign the group to the passed users.
Set<GroupPrivilege>	getAssignedPrivileges()	Get an unmodifiable view of the current assigned privileges which are held in this SystemGroupModifier.
Set<User>	getAssignedUsers()	Get an unmodifiable view of the current assigned users which are held in this SystemGroupModifier.
Tenant	getTenant()	Get the current tenant which is held in this SystemGroupModifier.
SystemGroupModifier	removeAssignedCategories(Category... categories)	Remove the assignment of the group to the passed categories.
SystemGroupModifier	removeAssignedPrivileges(GroupPrivilege... groupPrivileges)	Remove the passed privileges from the group.
SystemGroupModifier	removeAssignedUsers(User... users)	Remove the assignment of the group to the passed users.
SystemGroupModifier	setDescription(String description)	Change the description of the associated Group.
SystemGroupModifier	setName(String name)	Change the name of the associated Group.
SystemGroupModifier	setParent(SystemGroup parent)	Change the parent system group of the associated Group.
SystemGroupModifier	setTenant(Tenant tenant)	Change the tenant of the associated SystemGroup.
boolean	validateTenant(Tenant tenant)	Validate the given tenant.

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

SystemGroupModifier 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<SystemGroup>

Parameters:

name - the new name as String

Returns:

the GroupModifier

Throws:

ValidationException - if the new name is invalid

setDescription

SystemGroupModifier 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<SystemGroup>

Parameters:

description - the new description as String

Returns:

the GroupModifier

Throws:

ValidationException - if the new description is invalid

addAssignedCategories

SystemGroupModifier 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<SystemGroup>

Parameters:

categories - the categories the group should be assigned to

Returns:

the GroupModifier

Throws:

ValidationException - if a category is null

removeAssignedCategories

SystemGroupModifier 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<SystemGroup>

Parameters:

categories - the categories for which the assignment should be removed

Returns:

the GroupModifier

Throws:

ValidationException - if a category is null

setParent

SystemGroupModifier 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<SystemGroup>

Parameters:

parent - the new parent system group

Returns:

the GroupModifier

Throws:

ValidationException - if the new parent is invalid

getTenant

Tenant getTenant()

Get the current tenant which is held in this SystemGroupModifier.

Returns:

the current tenant

Since:

10.0.108

setTenant

SystemGroupModifier setTenant(Tenant tenant)
                       throws ValidationException

Change the tenant of the associated SystemGroup.

The change is applied after the Modifier.write() method is called.

Parameters:

tenant - the new tenant

Returns:

the SystemGroupModifier

Throws:

ValidationException - if the new tenant is invalid

Since:

10.0.108

validateTenant

boolean validateTenant(Tenant tenant)
                throws ValidationException

Validate the given tenant.

Parameters:

tenant - the tenant to validate

Returns:

true if the tenant is valid

Throws:

ValidationException - if the tenant is invalid

Since:

10.0.108

getAssignedUsers

Set<User> getAssignedUsers()

Get an unmodifiable view of the current assigned users which are held in this SystemGroupModifier.

Returns:

the current assigned users as an unmodifiable set

Since:

10.0.108

addAssignedUsers

SystemGroupModifier addAssignedUsers(User... users)
                              throws ValidationException

Assign the group to the passed users.

The change is applied after the Modifier.write() method is called.

Parameters:

users - the users the group should be assigned to

Returns:

the SystemGroupModifier

Throws:

ValidationException - if a user is null

Since:

10.0.108

removeAssignedUsers

SystemGroupModifier removeAssignedUsers(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 SystemGroupModifier

Throws:

ValidationException - if a user is null

Since:

10.0.108

getAssignedPrivileges

Set<GroupPrivilege> getAssignedPrivileges()

Get an unmodifiable view of the current assigned privileges which are held in this SystemGroupModifier.

Returns:

the current assigned privileges as an unmodifiable set

Since:

12.29

addAssignedPrivileges

SystemGroupModifier addAssignedPrivileges(GroupPrivilege... groupPrivileges)
                                   throws ValidationException

Assign the passed privileges to the group.

The change is applied after the Modifier.write() method is called.

Parameters:

groupPrivileges - the privileges that should be assigned to the group

Returns:

the SystemGroupModifier

Throws:

ValidationException - if a privilege is null

Since:

12.29

removeAssignedPrivileges

SystemGroupModifier removeAssignedPrivileges(GroupPrivilege... groupPrivileges)
                                      throws ValidationException

Remove the passed privileges from the group.

The change is applied after the Modifier.write() method is called.

Parameters:

groupPrivileges - the privileges for which the assignment should be removed

Returns:

the SystemGroupModifier

Throws:

ValidationException - if a privilege is null or the group is the administration group

Since:

12.29