com.centrasite.resourceaccess.resources
Interface CentraSiteRole

All Superinterfaces:
ResourceAccessType

public interface CentraSiteRole
extends ResourceAccessType

Represents a CentraSite Role.


Method Summary
 void addPermissions(java.util.Collection<CentraSitePermission> permissions)
          Add specified permissions to this role.
 javax.xml.registry.infomodel.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 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(javax.xml.registry.infomodel.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.
 
Methods inherited from interface com.centrasite.resourceaccess.resources.ResourceAccessType
addAssociations, addClassifications, addExternalLinks, addSlots, getAssociations, getClassifications, getDescription, getDisplayName, getExternalLinks, getExternalProperties, getId, getProperties, getSlots, preDelete, preSave, removeAssociations, removeClassifications, removeExternalLinks, removeProperties, removeSlots, setDescription, setDisplayName, setProperties, synchronizeProperties
 

Method Detail

getPermissions

java.util.Collection<CentraSitePermission> getPermissions()
                                                          throws javax.xml.registry.JAXRException,
                                                                 com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get the permissions applicable to this role.

Returns:
permissions (may be empty but not null)
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

addPermissions

void addPermissions(java.util.Collection<CentraSitePermission> permissions)
                    throws javax.xml.registry.JAXRException,
                           com.softwareag.security.jaas.principals.SagGeneralSecurityException
Add specified permissions to this role.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

removePermissions

void removePermissions(java.util.Collection<CentraSitePermission> permissions)
                       throws javax.xml.registry.JAXRException,
                              com.softwareag.security.jaas.principals.SagGeneralSecurityException
Remove specified permissions from this role.

Parameters:
permissions - Permissions to be removed.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

setOrganization

void setOrganization(javax.xml.registry.infomodel.Organization organization)
Sets the organization this role is related to.

Parameters:
organization - The organization to relate to.

getOrganization

javax.xml.registry.infomodel.Organization getOrganization()
Gets the organization this role is related to.


save

void save()
          throws javax.xml.registry.JAXRException,
                 com.softwareag.security.jaas.principals.SagGeneralSecurityException
Persist the role. Either persists freshly created role or updates existing one.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

isSystemLevel

boolean isSystemLevel()
                      throws javax.xml.registry.JAXRException,
                             com.softwareag.security.jaas.principals.SagGeneralSecurityException
Check if this is a system level role.

Returns:
true if this is a system level role.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

isOrganizationAdministrator

boolean isOrganizationAdministrator()
                                    throws javax.xml.registry.JAXRException
Check whether this role is Organization Administrator Role.

Returns:
true or false.
Throws:
javax.xml.registry.JAXRException

setOrganizationAdministrator

void setOrganizationAdministrator(boolean isOrganizationAdministrator)
Set whether this Role is Organization Administrator Role.

Parameters:
isOrganizationAdministrator - true or false.

isSystemDefined

boolean isSystemDefined()
                        throws javax.xml.registry.JAXRException
Check whether this Role is system defined i.e. immutable.

Returns:
true or false.
Throws:
javax.xml.registry.JAXRException

setSystemDefined

void setSystemDefined(boolean isSystemDefined)
Set whether the Role is system defined and immutable or not.

Parameters:
isSystemDefined - true or false.

isUserDefined

boolean isUserDefined()
                      throws javax.xml.registry.JAXRException
Check whether this Role is user defined i.e. mutable.

Returns:
true or false.
Throws:
javax.xml.registry.JAXRException

setUserDefined

void setUserDefined(boolean isUserDefined)
Set whether the Role is user defined and mutable or not.

Parameters:
isUserDefined - true or false.