org.alfresco.module.org_alfresco_module_rm.role

Interface FilePlanRoleService

All Known Implementing Classes:

FilePlanRoleServiceImpl

@AlfrescoPublicApi
public interface FilePlanRoleService

Role service interface

Since:

2.1

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE_ADMIN
static String	ROLE_EXTENDED_READERS
static String	ROLE_EXTENDED_WRITERS
static String	ROLE_POWER_USER
static String	ROLE_RECORDS_MANAGER
static String	ROLE_SECURITY_OFFICER
static String	ROLE_USER Default role names
static List<String>	SYSTEM_ROLES System roles

Method Summary

Modifier and Type	Method and Description
void	assignRoleToAuthority(org.alfresco.service.cmr.repository.NodeRef filePlan, String role, String authorityName) Assign a role to an authority
Role	createRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role, String roleDisplayLabel, Set<Capability> capabilities) Create a new role
void	deleteRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role) Delete a role
boolean	existsRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role) Indicate whether a role exists for a given records management root node
Set<String>	getAllAssignedToRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role) Gets all the groups and users that have been directly assigned to a role.
String	getAllRolesContainerGroup(org.alfresco.service.cmr.repository.NodeRef filePlan) Returns the name of the container group for all roles of a specified file plan.
Set<String>	getGroupsAssignedToRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role) Gets all the groups that have been directly assigned to a role.
Role	getRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role) Get a role by name
Set<Role>	getRoles(org.alfresco.service.cmr.repository.NodeRef filePlan) Get all the available roles for the given records management root node (includes also the system roles)
Set<Role>	getRoles(org.alfresco.service.cmr.repository.NodeRef filePlan, boolean includeSystemRoles) Get all the available roles for the given records management root node.
Set<Role>	getRolesByUser(org.alfresco.service.cmr.repository.NodeRef filePlan, String user) Gets the roles for a given user (includes also the system roles)
Set<Role>	getRolesByUser(org.alfresco.service.cmr.repository.NodeRef filePlan, String user, boolean includeSystemRoles) Gets the roles for a given user.
Set<String>	getUsersAssignedToRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role) Gets all the users that have been directly assigned to a role.
boolean	hasRMAdminRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String user) Determines whether the given user has the RM Admin role
void	setupFilePlanRoles(org.alfresco.service.cmr.repository.NodeRef filePlan) Sets up the roles on a new file plan.
void	tearDownFilePlanRoles(org.alfresco.service.cmr.repository.NodeRef filePlan) Tears down the roles on a file plan.
void	unassignRoleFromAuthority(org.alfresco.service.cmr.repository.NodeRef filePlan, String role, String authorityName) Unassign a role from an authority
Role	updateRole(org.alfresco.service.cmr.repository.NodeRef filePlan, String role, String roleDisplayLabel, Set<Capability> capabilities) Update an existing role

Field Detail

ROLE_USER

static final String ROLE_USER

Default role names

See Also:

Constant Field Values

ROLE_POWER_USER

static final String ROLE_POWER_USER

See Also:

Constant Field Values

ROLE_SECURITY_OFFICER

static final String ROLE_SECURITY_OFFICER

See Also:

Constant Field Values

ROLE_RECORDS_MANAGER

static final String ROLE_RECORDS_MANAGER

See Also:

Constant Field Values

ROLE_ADMIN

static final String ROLE_ADMIN

See Also:

Constant Field Values

ROLE_EXTENDED_READERS

static final String ROLE_EXTENDED_READERS

See Also:

Constant Field Values

ROLE_EXTENDED_WRITERS

static final String ROLE_EXTENDED_WRITERS

See Also:

Constant Field Values

SYSTEM_ROLES

static final List<String> SYSTEM_ROLES

System roles

Method Detail

setupFilePlanRoles

void setupFilePlanRoles(org.alfresco.service.cmr.repository.NodeRef filePlan)

Sets up the roles on a new file plan.

Parameters:

filePlan - file plan

tearDownFilePlanRoles

void tearDownFilePlanRoles(org.alfresco.service.cmr.repository.NodeRef filePlan)

Tears down the roles on a file plan.

Parameters:

filePlan - file plan

getAllRolesContainerGroup

String getAllRolesContainerGroup(org.alfresco.service.cmr.repository.NodeRef filePlan)

Returns the name of the container group for all roles of a specified file plan.

Parameters:

filePlan - file plan node reference

Returns:

String group name

getRoles

Set<Role> getRoles(org.alfresco.service.cmr.repository.NodeRef filePlan)

Get all the available roles for the given records management root node (includes also the system roles)

Parameters:

filePlan - file plan

Returns:

getRoles

Set<Role> getRoles(org.alfresco.service.cmr.repository.NodeRef filePlan,
                   boolean includeSystemRoles)

Get all the available roles for the given records management root node. System roles can be filtered

Parameters:

filePlan - file plan

includeSystemRoles - system roles

Returns:

getRolesByUser

Set<Role> getRolesByUser(org.alfresco.service.cmr.repository.NodeRef filePlan,
                         String user)

Gets the roles for a given user (includes also the system roles)

Parameters:

filePlan - file plan

user - user

Returns:

getRolesByUser

Set<Role> getRolesByUser(org.alfresco.service.cmr.repository.NodeRef filePlan,
                         String user,
                         boolean includeSystemRoles)

Gets the roles for a given user. System roles can be filtered

Parameters:

filePlan - file plan

user - user

includeSystemRoles - system roles

Returns:

getRole

Role getRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
             String role)

Get a role by name

Parameters:

filePlan - file plan

role - role

Returns:

existsRole

boolean existsRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                   String role)

Indicate whether a role exists for a given records management root node

Parameters:

filePlan - file plan

role - role

Returns:

hasRMAdminRole

boolean hasRMAdminRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                       String user)

Determines whether the given user has the RM Admin role

Parameters:

filePlan - filePlan

user - user name to check

Returns:

true if the user has the RM Admin role, false otherwise

createRole

Role createRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                String role,
                String roleDisplayLabel,
                Set<Capability> capabilities)

Create a new role

Parameters:

filePlan - file plan

role -

roleDisplayLabel -

capabilities -

Returns:

updateRole

Role updateRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                String role,
                String roleDisplayLabel,
                Set<Capability> capabilities)

Update an existing role

Parameters:

filePlan - file plan

role -

roleDisplayLabel -

capabilities -

Returns:

deleteRole

void deleteRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                String role)

Delete a role

Parameters:

filePlan - file plan

role - role

getUsersAssignedToRole

Set<String> getUsersAssignedToRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                                   String role)

Gets all the users that have been directly assigned to a role.

Parameters:

filePlan - file plan

role - role

Returns:

Set<String> set of users

getGroupsAssignedToRole

Set<String> getGroupsAssignedToRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                                    String role)

Gets all the groups that have been directly assigned to a role.

Parameters:

filePlan - file plan

role - role

Returns:

Set<String> set of groups

getAllAssignedToRole

Set<String> getAllAssignedToRole(org.alfresco.service.cmr.repository.NodeRef filePlan,
                                 String role)

Gets all the groups and users that have been directly assigned to a role.

Parameters:

filePlan - file plan

role - role

Returns:

Set<String> set of groups and users

assignRoleToAuthority

void assignRoleToAuthority(org.alfresco.service.cmr.repository.NodeRef filePlan,
                           String role,
                           String authorityName)

Assign a role to an authority

Parameters:

filePlan - file plan

role - role

authorityName - authority name

unassignRoleFromAuthority

void unassignRoleFromAuthority(org.alfresco.service.cmr.repository.NodeRef filePlan,
                               String role,
                               String authorityName)

Unassign a role from an authority

Parameters:

filePlan - file plan

role - role

authorityName - authority name