com.ibm.pim.organization
Interface AccessControlGroup


public interface AccessControlGroup

Access control groups are used to set the permissions in accordance to which users can view/edit specific objects like catalogs, hierarchies, selections, workflows and collaboration areas.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getDescription()
          Retrieves the description applied to this access control group
 java.lang.String getName()
          Retrieves the name applied to this access control group
 java.util.Set<Permission> getPermissionList(Role role)
          Identifies the permissions set on for this Access Control Group
 java.util.Collection<Role> getRoles()
          Retrieve the roles associated with this AccessControlGroup
 void grantPermissions(Role role, java.util.Set<Permission> permissions)
          Grants the given set of permissions to this role.
 void revokePermissions(Role role, java.util.Set<Permission> permissions)
          Revokes the given set of permissions to this role.
 void save()
          Saves this Access Control Group
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Retrieves the name applied to this access control group

Returns:
the name
Throws:
PIMInternalException - If an internal error occurs

getDescription

java.lang.String getDescription()
Retrieves the description applied to this access control group

Returns:
the description
Throws:
PIMInternalException - If an internal error occurs

getPermissionList

java.util.Set<Permission> getPermissionList(Role role)
Identifies the permissions set on for this Access Control Group

Parameters:
role - the role for which the Access Control Group permissions are to be retrieved.
Returns:
a set of permissions
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If any of the input parameters is null.
java.lang.IllegalStateException - If the role has not been persisted.

getRoles

java.util.Collection<Role> getRoles()
Retrieve the roles associated with this AccessControlGroup

Returns:
collection of Roles
Throws:
PIMInternalException - If an internal error occurs

save

void save()
Saves this Access Control Group

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS

grantPermissions

void grantPermissions(Role role,
                      java.util.Set<Permission> permissions)
Grants the given set of permissions to this role. Permissions which are not part of the given set are not overwritten.

Parameters:
role - the role to which the permissions are to be applied
permissions - the permissions to be set
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
java.lang.IllegalArgumentException - If any of the input parameters is null.
java.lang.IllegalStateException - If any of the API objects passed as input parameter has not been saved.

revokePermissions

void revokePermissions(Role role,
                       java.util.Set<Permission> permissions)
Revokes the given set of permissions to this role. Permissions which are not part of the given set are not overwritten.

Parameters:
role - the role to which the permissions are to be applied
permissions - the permissions to be set
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the current user does not have the equivalent of SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
java.lang.IllegalArgumentException - If any of the input parameters is null.
java.lang.IllegalStateException - If any of the API objects passed as input parameter has not been saved.