com.canto.cumulus.usermanagement

Class AuthenticationManager.Department

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.usermanagement.AuthenticationManager.Department

Enclosing class:

AuthenticationManager

public static class AuthenticationManager.Department
extends RecordPackWrapper

This class describes a single department and provides access to the child departments.

Since:

8.5

See Also:

AuthenticationManager.getDepartments()

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationManager.Department	addSubDepartment(java.lang.String subDepartment) Add another child department.
java.util.Set<java.lang.String>	getAllNames() Returns a set of all used department names starting from this department tree node.
int	getID() Returns the id for this department.
java.lang.String	getName() Return the name of this department or null if this is the root department.
java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>>	getParentHierarchy(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> result, java.util.Set<java.lang.Integer> parentIDs) Returns a map of all department ids pointing to their set of parent department ids.
java.util.List<AuthenticationManager.Department>	getSubDepartments() Returns the direct children of this department.
void	installNoValue() Overrides this department to be the no value department
void	installNoValue(java.util.Locale locale) Overrides this department to be the no value department
boolean	isRoot() Returns whether this is the placeholder department representing the root node for the department tree.
boolean	isValidName(java.lang.String departmentName) Returns whether the given name can be used for a new department.
void	removeSubDepartment(AuthenticationManager.Department subDepartment) Remove the given child department.
void	setName(java.lang.String name) Rename this department to the given new name.

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

isRoot

public boolean isRoot()

Returns whether this is the placeholder department representing the root node for the department tree.

Returns:

true if this is the placeholder department representing the root node for the department tree

getName

public java.lang.String getName()

Return the name of this department or null if this is the root department.

Returns:

name of department

See Also:

isRoot()

setName

public void setName(java.lang.String name)

Rename this department to the given new name.

Parameters:

name - new name to use for this department

getID

public int getID()

Returns the id for this department.

Returns:

id for this department

getSubDepartments

public java.util.List<AuthenticationManager.Department> getSubDepartments()

Returns the direct children of this department.

Returns:

children of thi department

addSubDepartment

public AuthenticationManager.Department addSubDepartment(java.lang.String subDepartment)

Add another child department.

Parameters:

subDepartment - name for the new department

Returns:

the create child department instance

removeSubDepartment

public void removeSubDepartment(AuthenticationManager.Department subDepartment)

Remove the given child department.

Parameters:

subDepartment - the child to remove

installNoValue

public void installNoValue()

Overrides this department to be the no value department

installNoValue

public void installNoValue(java.util.Locale locale)

Overrides this department to be the no value department

Parameters:

locale - locale to use for the virtual non-existent 'No department assigned' department

Since:

8.5.1

getParentHierarchy

public java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> getParentHierarchy(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> result,
                                                                                   java.util.Set<java.lang.Integer> parentIDs)

Returns a map of all department ids pointing to their set of parent department ids.

Parameters:

result - provide null here

parentIDs - provide null here

Returns:

map of all department ids pointing to their set of parent department ids

getAllNames

public java.util.Set<java.lang.String> getAllNames()

Returns a set of all used department names starting from this department tree node.

Returns:

set of all used department names

isValidName

public boolean isValidName(java.lang.String departmentName)

Returns whether the given name can be used for a new department.

Parameters:

departmentName - name to check

Returns:

true if this name can be used for a new department