public interface Role extends CentraSiteRegistryObject
Modifier and Type | Method and Description |
---|---|
void |
addPermissions(java.util.Collection<Permission> permissions)
Add the given permissions to the role.
|
com.centrasite.resourceaccess.resources.CentraSiteRole |
getCentraSiteRole()
Get the RAM
CentraSiteRole instance that is wrapped by this instance. |
java.lang.String |
getDisplayName()
Get the display name for the role.
|
java.util.Collection<Group> |
getGroups()
Retrieves the list of groups which are assigned the current role.
|
java.lang.String |
getId()
Get the UUID key for the role.
|
java.lang.String |
getOrgDescription()
Get the description of the organization to which this role belongs.
|
java.lang.String |
getOrgName()
Get the name of the organization to which this role belongs.
|
java.util.Collection<Permission> |
getPermissions()
Get the permissions of the role.
|
java.util.Collection<User> |
getUsers()
Retrieves the list of users who are assigned the current Role either directly or indirectly
inherited through role assignment to belonging group.
|
boolean |
isOrganizationAdministrator()
Checks if this role is the Organization Administrator role for an organization.
|
boolean |
isSystemDefined()
Checks if this role is a system defined role (pre-defined role).
|
boolean |
isSystemLevel()
Checks whether the role is a system level role or an organization specific role.
|
boolean |
isUserDefined()
Checks whether this role is user defined or not.
|
void |
removePermissions(java.util.Collection<Permission> permissions)
Remove the given permissions from the role.
|
void |
setOrganizationAdministrator(boolean isOrganizationAdministrator)
Set whether this role is the Organization Administrator role or not.
|
void |
setSystemDefined(boolean isSystemDefined)
Set whether the role is a system defined role or not.
|
void |
setUserDefined(boolean isUserDefined)
Set whether the role is user defined or not.
|
getConsumers, getDescription, getDescription, getDisplayVersion, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getSubscribers, getSystemVersion, getTitle, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
java.util.Collection<Permission> getPermissions() throws CLLException
Collection
of Permission
s assigned to the role.CLLException
- If an error occurs while trying to fetch the role's permissionsvoid addPermissions(java.util.Collection<Permission> permissions) throws CLLException
permissions
- The Permission
s to add to the roleCLLException
- If an error occurs while adding the permissionsvoid removePermissions(java.util.Collection<Permission> permissions) throws CLLException
permissions
- The Collection
of Permission
s to remove from the roleCLLException
- If an error occurs while removing the permissionsboolean isSystemLevel() throws CLLException
CLLException
- If an error occurs while doing the checkboolean isOrganizationAdministrator() throws CLLException
CLLException
- If an error occurs while trying to check the rolevoid setOrganizationAdministrator(boolean isOrganizationAdministrator)
isOrganizationAdministrator
- If true, this role is the Organization Administrator roleboolean isSystemDefined() throws CLLException
CLLException
- If an error occurs while performing the checkvoid setSystemDefined(boolean isSystemDefined)
isSystemDefined
- If true, the role is system definedboolean isUserDefined() throws CLLException
CLLException
- If an error occurs while performing the checkvoid setUserDefined(boolean isUserDefined)
isUserDefined
- If true, the role is user definedcom.centrasite.resourceaccess.resources.CentraSiteRole getCentraSiteRole() throws CLLException
CentraSiteRole
instance that is wrapped by this instance.CentraSiteRole
instanceCLLException
- If an error occurs while trying to get the RAM instancejava.lang.String getId() throws CLLException
getId
in interface CentraSiteObject
CLLException
- If an error occurs while trying to get the key for the rolejava.lang.String getDisplayName() throws CLLException
CLLException
- If an error occurs while trying to fetch the display namejava.lang.String getOrgName() throws CLLException
CLLException
- If an error occurs while trying to get the organization's namejava.lang.String getOrgDescription() throws CLLException
CLLException
- If an error occurs while trying to get the organization's descriptionjava.util.Collection<User> getUsers() throws CLLException
Collection
of User
s who are assigned the current roleCLLException
- If an error is encountered while trying to retrieve the usersjava.util.Collection<Group> getGroups() throws CLLException
Collection
of Group
s which are assigned the roleCLLException
- If an error is encountered while trying to retrieve the groups