public interface CentraSiteRole extends ResourceAccessType
Modifier and Type | Method and Description |
---|---|
void |
addPermissions(java.util.Collection<CentraSitePermission> permissions)
Add specified permissions to this role.
|
Organization |
getOrganization()
Gets the organization this role is related to.
|
java.util.Collection<CentraSitePermission> |
getPermissions()
Get the permissions applicable to this role.
|
boolean |
isOrganizationAdministrator()
Check whether this role is the Organization Administrator Role.
|
boolean |
isSystemDefined()
Check whether this Role is system defined i.e. immutable.
|
boolean |
isSystemLevel()
Check if this is a system level role.
|
boolean |
isUserDefined()
Check whether this Role is user defined i.e. mutable.
|
void |
removePermissions(java.util.Collection<CentraSitePermission> permissions)
Remove specified permissions from this role.
|
void |
save()
Persist the role.
|
void |
setOrganization(Organization organization)
Sets the organization this role is related to.
|
void |
setOrganizationAdministrator(boolean isOrganizationAdministrator)
Set whether this Role is Organization Administrator Role.
|
void |
setSystemDefined(boolean isSystemDefined)
Set whether the Role is system defined and immutable or not.
|
void |
setUserDefined(boolean isUserDefined)
Set whether the Role is user defined and mutable or not.
|
addAssociations, addClassifications, addExternalLinks, addSlots, getAssociations, getClassifications, getDescription, getDisplayName, getExternalLinks, getExternalProperties, getId, getProperties, getSlots, preDelete, preSave, removeAssociations, removeClassifications, removeExternalLinks, removeProperties, removeSlots, setDescription, setDisplayName, setProperties, synchronizeProperties
java.util.Collection<CentraSitePermission> getPermissions() throws JAXRException, SagGeneralSecurityException
Collection
of CentraSitePermission
objects which are related to the role (may be empty but not null)JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid addPermissions(java.util.Collection<CentraSitePermission> permissions) throws JAXRException, SagGeneralSecurityException
permissions
- The Collection
of CentraSitePermission
to assign to this roleJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid removePermissions(java.util.Collection<CentraSitePermission> permissions) throws JAXRException, SagGeneralSecurityException
permissions
- The Collection
of CentraSitePermission
objects to remove from the roleJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid setOrganization(Organization organization)
organization
- The Organization
to relate to this role (i.e., the organization to which this role will belong to)Organization getOrganization()
Organization
to which this role belongsvoid save() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean isSystemLevel() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean isOrganizationAdministrator() throws JAXRException
JAXRException
- If a JAXR error occurs while trying to check the rolevoid setOrganizationAdministrator(boolean isOrganizationAdministrator)
isOrganizationAdministrator
- If true, the role will have a classification to the Organization Administrator concept, if false, such a classification will not be added.boolean isSystemDefined() throws JAXRException
JAXRException
- If a JAXR error occursvoid setSystemDefined(boolean isSystemDefined)
isSystemDefined
- If true the role will be a system defined roleboolean isUserDefined() throws JAXRException
JAXRException
- If a JAXR error occursvoid setUserDefined(boolean isUserDefined)
isUserDefined
- If true the role will be a user defined role