com.lexmark.saperion.administration

Interface RoleManagementService

public interface RoleManagementService

The role management service provides the required operations to create, read, update and delete role entities in the user management system.

Author:

tfrisch

Method Summary

Modifier and Type	Method and Description
RoleReferenceType	createRole(RolePropertiesType properties) This method creates a new role with the properties and returns a reference to the new role.
void	deleteRole(RoleReferenceType reference) Deletes the role with the given reference.
List<AclReferenceType>	getACLs(RoleReferenceType reference) This method returns the ACLs currently set on the referenced role.
RoleType	loadRole(RoleReferenceType reference) This method returns a role with the given id.
RoleType	loadRoleByName(String name) Loads a role identified by its name.
SearchExecutionService<RoleListItemType>	newTenantDeletedRoleSearchService() This method returns a new SearchExecutionService that lists all deleted roles of the current user's tenant.
SearchExecutionService<RoleListItemType>	newTenantRoleSearchService() This method returns a new SearchExecutionService that lists all roles of the current user's tenant.
void	undeleteRole(RoleReferenceType reference) Un-deletes the role with the given reference.
void	updateRole(RoleReferenceType reference, RolePropertiesType properties) Updates the referenced role with the given properties.

Method Detail

loadRole

RoleType loadRole(RoleReferenceType reference)
           throws EcmException

This method returns a role with the given id.

Parameters:

reference - the reference of the role to get

Returns:

the role with the given id

Throws:

ResourceNotFoundException - the referenced role does not exist in the backend system

EcmException - indicates that a system exception occurred

loadRoleByName

RoleType loadRoleByName(String name)
                 throws EcmException

Loads a role identified by its name.

Parameters:

name - the name of the role to load

Returns:

the referenced role

Throws:

SystemException - indicates that a system exception occurred

EcmException

deleteRole

void deleteRole(RoleReferenceType reference)
         throws EcmException

Deletes the role with the given reference.

Parameters:

reference - the role reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

undeleteRole

void undeleteRole(RoleReferenceType reference)
           throws EcmException

Un-deletes the role with the given reference.

Parameters:

reference - the role reference

Throws:

EcmException - indicates that a system exception occurred

newTenantRoleSearchService

SearchExecutionService<RoleListItemType> newTenantRoleSearchService()
                                                             throws EcmException

This method returns a new SearchExecutionService that lists all roles of the current user's tenant.

Returns:

a new SearchExecutionService

Throws:

EcmException - indicates that a system exception occurred

newTenantDeletedRoleSearchService

SearchExecutionService<RoleListItemType> newTenantDeletedRoleSearchService()
                                                                    throws EcmException

This method returns a new SearchExecutionService that lists all deleted roles of the current user's tenant.

Returns:

a new SearchExecutionService

Throws:

EcmException - indicates that a system exception occurred

createRole

RoleReferenceType createRole(RolePropertiesType properties)
                      throws EcmException

This method creates a new role with the properties and returns a reference to the new role. A role-administrator user with the given password will be created automatically.

Parameters:

properties - the properties of the role

Returns:

a reference to the newly created role

Throws:

SystemException - indicates that a system exception occurred

EcmException

updateRole

void updateRole(RoleReferenceType reference,
                RolePropertiesType properties)
         throws EcmException

Updates the referenced role with the given properties.

Parameters:

reference - the role reference

properties - the new properties of the role

Throws:

ResourceNotFoundException - the referenced role does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

getACLs

List<AclReferenceType> getACLs(RoleReferenceType reference)
                        throws EcmException

This method returns the ACLs currently set on the referenced role.

Parameters:

reference - a reference to the role

Returns:

the ACLs currently set on the role

Throws:

EcmException - when loading the ACLs failed