|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Role
Role interface. User management in the system is controlled by roles. Privileges are set to roles and users inherit privileges based on the roles assigned to them.
Nested Class Summary | |
---|---|
static class |
Role.Privilege
Access Privileges for use with Catalog and Hierarchy objects |
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
delete()
Delete this role |
java.util.Collection<AccessControlGroup> |
getAccessControlGroups()
Provides a collection of Access Control Groups applicable to this role |
java.util.Collection<AttributeCollection> |
getAttributeCollectionForPrivilegeType(Catalog catalog,
Role.Privilege type)
Fetches the attribute collections on which the role has the mentioned type of privilege for the given catalog. |
java.util.Collection<AttributeCollection> |
getAttributeCollectionForPrivilegeType(Hierarchy hierarchy,
Role.Privilege type)
Fetches the attribute collections on which the role has the mentioned type of privilege for the given catalog. |
java.lang.String |
getDescription()
The textual description of this role |
java.util.List<java.util.Locale> |
getLocales()
The Locales applied to this role |
java.util.List<java.util.Locale> |
getLocales(Catalog catalog)
Retrieve the Locales applied to this role for a specific catalog |
java.util.List<java.util.Locale> |
getLocales(Hierarchy hierarchy)
Retrieve the Locales applied to this role for a specific hierarchy |
java.lang.String |
getName()
The name given to this role |
java.util.Set<Permission> |
getPermissionList(AccessControlGroup accessControlGroup)
Fetches the Permissions granted to this role as part of the given access control group. |
java.util.Set<ScreenPrivilege> |
getScreenPrivileges()
Fetches the set of screen privileges granted to this user. |
java.util.Set<SystemWideAccessPrivilege> |
getSystemWideAccessPrivileges()
Fetches the set of system wide access privileges granted to this user. |
PIMCollection<User> |
getUsers()
Identifies the Users applied to the Role |
void |
grantPermissions(AccessControlGroup accessControlGroup,
java.util.Set<Permission> permissions)
Grants the given set of permissions to this role as part of the given access control group. |
void |
grantScreenPrivileges(java.util.Set<ScreenPrivilege> privileges)
Grants the given screen privileges |
void |
grantSystemWideAccessPrivileges(java.util.Set<SystemWideAccessPrivilege> privileges)
Grants the given system wide access privileges |
void |
revokePermissions(AccessControlGroup accessControlGroup,
java.util.Set<Permission> permissions)
Revokes the given set of permissions to this role as part of the given access control group. |
void |
revokeScreenPrivileges(java.util.Set<ScreenPrivilege> privileges)
Revokes the given screen privileges |
void |
revokeSystemWideAccessPrivileges(java.util.Set<SystemWideAccessPrivilege> privileges)
Revokes the given system wide access privileges |
void |
save()
Saves this role information |
void |
setAttributeCollectionPrivilege(Catalog catalog,
Role.Privilege privilege,
java.util.Collection<AttributeCollection> collections)
Sets the privileges for a role on attribute collections for a catalog. |
void |
setAttributeCollectionPrivilege(Hierarchy hierarchy,
Role.Privilege privilege,
java.util.Collection<AttributeCollection> collections)
Sets the privileges for a role on attribute collections for a hierarchy. |
void |
setLocales(Catalog catalog,
java.util.List<java.util.Locale> locales)
Sets an array of Locales appropriate for this Role and specific catalog. |
void |
setLocales(Hierarchy hierarchy,
java.util.List<java.util.Locale> locales)
Sets an array of Locales appropriate for this Role and specific hierarchy. |
void |
setLocales(java.util.List<java.util.Locale> locales)
Sets an array of Locales appropriate for this Role |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void delete()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user is not the user being accessed and the
current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
java.util.Collection<AccessControlGroup> getAccessControlGroups()
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getAttributeCollectionForPrivilegeType(Catalog catalog, Role.Privilege type)
catalog
- The selected catalogtype
- EDIT or VIEW
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If any of the input parameters is null.
java.lang.IllegalStateException
- If the catalog has not been persisted.java.util.Collection<AttributeCollection> getAttributeCollectionForPrivilegeType(Hierarchy hierarchy, Role.Privilege type)
hierarchy
- The selected hierarchytype
- EDIT or VIEW
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If any of the input parameters is null.
java.lang.IllegalStateException
- If the hierarchy has not been persisted.java.lang.String getDescription()
PIMInternalException
- If an internal error occursjava.util.List<java.util.Locale> getLocales()
PIMInternalException
- If an internal error occursjava.util.List<java.util.Locale> getLocales(Catalog catalog)
catalog
- The selected catalog
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If catalog object is null
java.lang.IllegalStateException
- If the catalog has not been persistedjava.util.List<java.util.Locale> getLocales(Hierarchy hierarchy)
hierarchy
- The selected hierarchy
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If any of the input parameters is null
java.lang.IllegalStateException
- If any of the API objects passed as parameter has not been
persisted.java.lang.String getName()
PIMInternalException
- If an internal error occursPIMCollection<User> getUsers()
PIMInternalException
- If an internal error occursvoid save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
void setAttributeCollectionPrivilege(Catalog catalog, Role.Privilege privilege, java.util.Collection<AttributeCollection> collections)
catalog
- The selected Catalogprivilege
- Edit or Viewcollections
- AttributeCollections
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 a parameter has not been
saved.void setAttributeCollectionPrivilege(Hierarchy hierarchy, Role.Privilege privilege, java.util.Collection<AttributeCollection> collections)
hierarchy
- The selected hierarchyprivilege
- Edit or Viewcollections
- AttributeCollections
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 a parameter has not been
saved.void setLocales(java.util.List<java.util.Locale> locales)
locales
- list of locales
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.void setLocales(Catalog catalog, java.util.List<java.util.Locale> locales)
catalog
- The selected cataloglocales
- list of locales
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 a parameter has not been
saved.void setLocales(Hierarchy hierarchy, java.util.List<java.util.Locale> locales)
hierarchy
- The selected hierarchylocales
- list of locales
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 a parameter has not been
saved.void grantSystemWideAccessPrivileges(java.util.Set<SystemWideAccessPrivilege> privileges)
privileges
- Set of system wide access privileges
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.void revokeSystemWideAccessPrivileges(java.util.Set<SystemWideAccessPrivilege> privileges)
privileges
- Set of system wide access privileges
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.util.Set<SystemWideAccessPrivilege> getSystemWideAccessPrivileges()
PIMInternalException
- If an internal error occursjava.util.Set<Permission> getPermissionList(AccessControlGroup accessControlGroup)
accessControlGroup
- The access control group corresponding to which permissions
have to be fetched.
PIMInternalException
- If an internal error occurs.
java.lang.IllegalArgumentException
- If any of the input parameters is null.
java.lang.IllegalStateException
- If any of the API object passed as parameter has not been
persisted.void grantPermissions(AccessControlGroup accessControlGroup, java.util.Set<Permission> permissions)
accessControlGroup
- The access control group corresponding to which the
permissions have to be granted.permissions
- The set of permissions to be granted
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 input parameters has not been persisted.void revokePermissions(AccessControlGroup accessControlGroup, java.util.Set<Permission> permissions)
accessControlGroup
- The access control group corresponding to which the
permissions have to be granted.permissions
- The set of permissions to be granted
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 input parameters has not been persisted.java.util.Set<ScreenPrivilege> getScreenPrivileges()
PIMInternalException
- If an internal error occursvoid grantScreenPrivileges(java.util.Set<ScreenPrivilege> privileges)
privileges
- Set of screen privileges
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.void revokeScreenPrivileges(java.util.Set<ScreenPrivilege> privileges)
privileges
- Set of screen privileges
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |