com.canto.cumulus.prefs

Class RestrictionsList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.RestrictionsList

public class RestrictionsList
extends ListPackManager

This class manages a list of roles and user UIDs for editability restrictions.

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(UserContext userContext) Returns whether the given UserContext matches one of the stored UIDs of this instance.
void	addUID(java.lang.String uid) Add a user or role UID to this list.
java.util.Collection<java.lang.String>	getUIDs() Returns the list of all UIDs currently contained in this list.
void	removeAllUIDs() Clears this restrictions list.
boolean	removeUID(java.lang.String uid) Removes a user or role UID from this list.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

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

Method Detail

addUID

public void addUID(java.lang.String uid)

Add a user or role UID to this list.

Parameters:

uid - UID to add

removeUID

public boolean removeUID(java.lang.String uid)

Removes a user or role UID from this list.

Parameters:

uid - UID to remove

Returns:

true if the UID was found and removed

removeAllUIDs

public void removeAllUIDs()

Clears this restrictions list.

Since:

9.2

accepts

public boolean accepts(UserContext userContext)

Returns whether the given UserContext matches one of the stored UIDs of this instance.

Parameters:

userContext - the UserContext to check

Returns:

true if the unique user UID or on of the role UIDs of the given UserContext is contained

Since:

9.2

getUIDs

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

Returns the list of all UIDs currently contained in this list.

Returns:

list of String instances