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

Interface IOrgStructure

  • All Known Implementing Classes:
    OrgStructure
    @Scriptable
public interface IOrgStructure

    • Method Detail

      • getPseudoRootNode

        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

        boolean containsContainerNode​(String p_strId)
        Check if the org structure contains a container with the given given unique identifier.
        Parameters:
        p_strId - The unique identifier.
        Returns:
        true if the container was found, or false otherwise.

      • getContainerNode

        DsContainerNode getContainerNode​(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

        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

        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

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

      • containsSetNode

        boolean containsSetNode​(String p_strId)
        Check if the org structure contains a set with the given given unique identifier.
        Parameters:
        p_strId - The unique identifier.
        Returns:
        true if the set was found, or false otherwise.

      • getSetNode

        DsSetNode getSetNode​(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

        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

        Iterator<DsSetNode> getSetIterator()
        Returns:
        An iterator over all sets in the org structure.