com.canto.cumulus.db.permissions

Class PermissionsList

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.utils.ListPackWrapper

com.canto.cumulus.db.permissions.PermissionsList

public final class PermissionsList
extends ListPackWrapper

This class manages the permissions for a list of entities.

See Also:

Permissions, PermissionManager.getPermissionsList(com.canto.cumulus.MultiItemCollection, java.util.Set)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermission(java.lang.String userOrRole, java.lang.String permission, boolean childPermissions) Adds for the specified role or user the given permission for all entities.
int	countPermissions() Returns the number of entities this list contains the permissions for.
Permissions	getPermissions(int index) Returns the permissions for the given index in this list.
Permissions	getPermissions(int catalogID, int sourceID) Returns the permissions for the given catalog ID and entity ID
java.util.Iterator	getPermissionsIterator() Returns an iterator for all contained permissions.
void	removePermission(java.lang.String userOrRole, java.lang.String permission, boolean childPermissions) Removes the specified permission for the specified role or user for all entities.
void	save() Saves all changes made.

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

countPermissions

public int countPermissions()

Returns the number of entities this list contains the permissions for.

Returns:

number of entities

getPermissions

public Permissions getPermissions(int index)

Returns the permissions for the given index in this list.

Parameters:

index - index of entity permissions

Returns:

permissions

addPermission

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

Adds for the specified role or user the given permission for all entities.

Parameters:

userOrRole - role name or user UID

permission - permission to add

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

removePermission

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

Removes the specified permission for the specified role or user for all entities.

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

getPermissions

public Permissions getPermissions(int catalogID,
                         int sourceID)

Returns the permissions for the given catalog ID and entity ID

Parameters:

catalogID - catalog ID

sourceID - entity ID

Returns:

the found permissions or null

save

public void save()
          throws InvalidStateException,
                 CumulusException

Saves all changes made.

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

getPermissionsIterator

public java.util.Iterator getPermissionsIterator()

Returns an iterator for all contained permissions.

Returns:

permissions iterator