Package de.uplanet.lucy.server.usermanager.orgstructure

Class OrgStructure

java.lang.Object

de.uplanet.lucy.server.usermanager.orgstructure.OrgStructure

All Implemented Interfaces:

IOrgStructure

@Scriptable
public final class OrgStructure
extends Object
implements IOrgStructure

This class is an in-memory representation of the Intrexx organizational structure.

Constructor Summary

Constructors

Constructor	Description
OrgStructure()
OrgStructure(IOrgStructure p_org)

Method Summary

Modifier and Type	Method	Description
boolean	containsContainerNode(String p_strId)	Check if the org structure contains a container with the given given unique identifier.
boolean	containsSetNode(String p_strId)	Check if the org structure contains a set with the given given unique identifier.
Iterator<DsContainerNode>	getContainerIterator()	Get an iterator over all the containers that are referenced by the internal collection of containers.
DsContainerNode	getContainerNode(int p_iId)	Get a container node by it's integer identifier.
DsContainerNode	getContainerNode(String p_strId)	Get a container node by it's unique identifier.
DsContainerNode	getPseudoRootNode()	Get the pseudo root node of the organizational structure.
DsContainerNode[]	getRootChildren()
Iterator<DsSetNode>	getSetIterator()
DsSetNode	getSetNode(int p_iId)	Get a set by it's integer identifier.
DsSetNode	getSetNode(String p_strId)	Get a set by it's unique identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrgStructure

public OrgStructure()

OrgStructure

public OrgStructure(IOrgStructure p_org)

Method Detail

getPseudoRootNode

public DsContainerNode getPseudoRootNode()

Description copied from interface: IOrgStructure

Get the pseudo root node of the organizational structure.

The children of this node are the top-level organizational container nodes and do not report the pseudo root as their parent.

Specified by:

getPseudoRootNode in interface IOrgStructure

Returns:

The pseudo root node.

containsContainerNode

public boolean containsContainerNode(String p_strId)

Description copied from interface: IOrgStructure

Check if the org structure contains a container with the given given unique identifier.

Specified by:

containsContainerNode in interface IOrgStructure

Parameters:

p_strId - The unique identifier.

Returns:

true if the container was found, or false otherwise.

getContainerNode

public DsContainerNode getContainerNode(String p_strId)

Description copied from interface: IOrgStructure

Get a container node by it's unique identifier.

Specified by:

getContainerNode in interface IOrgStructure

Parameters:

p_strId - The organizational container's unique identifier.

Returns:

The organizational container node, or null if none was found for the given unique identifier.

getContainerNode

public DsContainerNode getContainerNode(int p_iId)

Description copied from interface: IOrgStructure

Get a container node by it's integer identifier.

Note: Access by integer identifier is prohibited for non-usermanager packages. So don't use it in other layers.

Specified by:

getContainerNode in interface IOrgStructure

Parameters:

p_iId - The container's integer identifier.

Returns:

The container node, or null if none was found for the given integer identifier.

getContainerIterator

public Iterator<DsContainerNode> getContainerIterator()

Description copied from interface: IOrgStructure

Get an iterator over all the containers that are referenced by the internal collection of containers. This iterator does not guarantee any specific order.

Specified by:

getContainerIterator in interface IOrgStructure

Returns:

An iterator over all containers in the org structure.

getRootChildren

public DsContainerNode[] getRootChildren()

Specified by:

getRootChildren in interface IOrgStructure

Returns:

A possibly empty array of root containers.

containsSetNode

public boolean containsSetNode(String p_strId)

Description copied from interface: IOrgStructure

Check if the org structure contains a set with the given given unique identifier.

Specified by:

containsSetNode in interface IOrgStructure

Parameters:

p_strId - The unique identifier.

Returns:

true if the set was found, or false otherwise.

getSetNode

public DsSetNode getSetNode(String p_strId)

Description copied from interface: IOrgStructure

Get a set by it's unique identifier.

Specified by:

getSetNode in interface IOrgStructure

Parameters:

p_strId - The set's unique identifier.

Returns:

The set node, or null if none was found for the given unique identifier.

getSetNode

public DsSetNode getSetNode(int p_iId)

Description copied from interface: IOrgStructure

Get a set by it's integer identifier.

Specified by:

getSetNode in interface IOrgStructure

Parameters:

p_iId - The set's integer identifier.

Returns:

The set node, or null if none was found for the given integer identifier.

getSetIterator

public Iterator<DsSetNode> getSetIterator()

Specified by:

getSetIterator in interface IOrgStructure

Returns:

An iterator over all sets in the org structure.