com.canto.cumulus.db.permissions

Class Permissions

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.db.permissions.Permissions

public final class Permissions
extends RecordPackWrapper

This class wraps the permissions for a single entity like a record or category.

See Also:

PermissionManager.getPermissions(com.canto.cumulus.Item)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermission(java.lang.String userOrRole, java.lang.String permission) Adds for the specified role or user the given permission.
void	addPermission(java.lang.String userOrRole, java.lang.String permission, boolean childPermissions) Adds for the specified role or user the given permission.
void	copyFrom(Permissions permissions) Replaces all permissions with the permissions from the given permissions block.
int	getCatalogID() Returns the catalog ID for the entity of these permissions.
int	getSourceID() Returns the entity ID for the entity of these permissions.
java.util.Collection<java.lang.String>	getUserAndRoleNames() Returns the list of users and roles that currently have some permissions assigned in this permissions block.
java.util.Collection<java.lang.String>	getUserAndRoleNames(boolean childPermissions) Returns the list of users and roles that currently have some permissions assigned in this permissions block.
boolean	hasChanged() Returns whether permissions have changed.
boolean	hasPermission(java.lang.String userOrRole, java.lang.String permission) Returns whether the given role or user has the specified permission assigned.
boolean	hasPermission(java.lang.String userOrRole, java.lang.String permission, boolean childPermissions) Returns whether the given role or user has the specified permission assigned.
void	removeAllPermissions(java.lang.String userOrRole) Removes all permissions for the specified role or user.
void	removeAllPermissions(java.lang.String userOrRole, boolean childPermissions) Removes all permissions for the specified role or user.
void	removePermission(java.lang.String userOrRole, java.lang.String permission) Removes the specified permission for the specified role or user.
void	removePermission(java.lang.String userOrRole, java.lang.String permission, boolean childPermissions) Removes the specified permission for the specified role or user.
void	save() Saves the current state of permissions for the entity.
void	setUseChildPermissions(boolean value) In case of a category permissions block this configures whether the configured permissions should be automatically be assigned to newly created sub categories or whether the new child categories have their own permission block.
boolean	useChildPermissions() In case of a category permissions block this return value specified whether the configured permissions should be automatically be assigned to newly created sub categories or whether the new child categories have their own permission block.

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper

toXMLString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

copyFrom

public void copyFrom(Permissions permissions)

Replaces all permissions with the permissions from the given permissions block.

Parameters:

permissions - the permissions to replace these permissions with

getCatalogID

public int getCatalogID()

Returns the catalog ID for the entity of these permissions.

Returns:

catalog ID

getSourceID

public int getSourceID()

Returns the entity ID for the entity of these permissions. For a record this is the record ID and for category this is a category ID.

Returns:

entity ID

useChildPermissions

public boolean useChildPermissions()

In case of a category permissions block this return value specified whether the configured permissions should be automatically be assigned to newly created sub categories or whether the new child categories have their own permission block.

Returns:

true if the child categories have their own permissions block

See Also:

addPermission(String, String, boolean)

setUseChildPermissions

public void setUseChildPermissions(boolean value)

In case of a category permissions block this configures whether the configured permissions should be automatically be assigned to newly created sub categories or whether the new child categories have their own permission block.

Parameters:

value - set to true if the child categories should have their own permissions block

addPermission

public void addPermission(java.lang.String userOrRole,
                 java.lang.String permission)

Adds for the specified role or user the given permission.

Parameters:

userOrRole - role name or user UID

permission - permission to add

addPermission

public void addPermission(java.lang.String userOrRole,
                 java.lang.String permission,
                 boolean childPermissions)

Adds for the specified role or user the given permission.

Parameters:

userOrRole - role name or user UID

permission - permission to add

childPermissions - if set to true this settings belongs to the child categories

removeAllPermissions

public void removeAllPermissions(java.lang.String userOrRole)

Removes all permissions for the specified role or user.

Parameters:

userOrRole - role name or user UID

removeAllPermissions

public void removeAllPermissions(java.lang.String userOrRole,
                        boolean childPermissions)

Removes all permissions for the specified role or user.

Parameters:

userOrRole - role name or user UID

childPermissions - if true the removal is made on the child categories permissions block

removePermission

public void removePermission(java.lang.String userOrRole,
                    java.lang.String permission)

Removes the specified permission for the specified role or user.

Parameters:

userOrRole - role name or user UID

permission - the permission to remove

removePermission

public void removePermission(java.lang.String userOrRole,
                    java.lang.String permission,
                    boolean childPermissions)

Removes the specified permission for the specified role or user.

Parameters:

userOrRole - role name or user UID

permission - the permission to remove

childPermissions - if true the removal is made on the child categories permissions block

hasPermission

public boolean hasPermission(java.lang.String userOrRole,
                    java.lang.String permission)

Returns whether the given role or user has the specified permission assigned.

Parameters:

userOrRole - role name or user UID

permission - permission to check

Returns:

if this permission block has the permission granted

hasPermission

public boolean hasPermission(java.lang.String userOrRole,
                    java.lang.String permission,
                    boolean childPermissions)

Returns whether the given role or user has the specified permission assigned.

Parameters:

userOrRole - role name or user UID

permission - permission to check

childPermissions - if true the check is made on the child categories permissions block

Returns:

if this permission block has the permission granted

getUserAndRoleNames

public java.util.Collection<java.lang.String> getUserAndRoleNames()

Returns the list of users and roles that currently have some permissions assigned in this permissions block.

Returns:

collection of user UIDs and role names

getUserAndRoleNames

public java.util.Collection<java.lang.String> getUserAndRoleNames(boolean childPermissions)

Returns the list of users and roles that currently have some permissions assigned in this permissions block.

Parameters:

childPermissions - if true the work is made on the child categories permissions block

Returns:

collection of user UIDs and role names

hasChanged

public boolean hasChanged()

Returns whether permissions have changed.

Returns:

true if permissions have changed

save

public void save()
          throws InvalidStateException,
                 CumulusException

Saves the current state of permissions for the entity.

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error