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

java.lang.Object
  extended by de.uplanet.lucy.server.usermanager.orgstructure.OrgStructure

@Scriptable
public final class OrgStructure
extends java.lang.Object

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

Version:
$Revision: 76233 $

Constructor Summary
OrgStructure()
           
 
Method Summary
 boolean containsContainerNode(java.lang.String p_strId)
           
 boolean containsSetNode(java.lang.String p_strId)
           
 java.util.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(java.lang.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()
           
 java.util.Iterator<DsSetNode> getSetIterator()
           
 DsSetNode getSetNode(int p_iId)
          Get a set by it's integer identifier.
 DsSetNode getSetNode(java.lang.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()
Method Detail

getPseudoRootNode

public DsContainerNode getPseudoRootNode()
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.

Returns:
The pseudo root node.

containsContainerNode

public boolean containsContainerNode(java.lang.String p_strId)

getContainerNode

public DsContainerNode getContainerNode(java.lang.String p_strId)
Get a container node by it's unique identifier.

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)
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.

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 java.util.Iterator<DsContainerNode> getContainerIterator()
Get an iterator over all the containers that are referenced by the internal collection of containers. This iterator does not guarantee any specific order.

Returns:
An iterator over all containers in the org structure.

getRootChildren

public DsContainerNode[] getRootChildren()
Returns:
A possibly empty array of root containers.

containsSetNode

public boolean containsSetNode(java.lang.String p_strId)

getSetNode

public DsSetNode getSetNode(java.lang.String p_strId)
Get a set by it's unique identifier.

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)
Get a set by it's integer identifier.

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 java.util.Iterator<DsSetNode> getSetIterator()
Returns:
An iterator over all sets in the org structure.


Last updated: 2011-08-11 10-04
Copyright © 2000-2011 United Planet. All Rights Reserved.