Skip navigation links

oracle.iam.rm.client
Interface HierarchyNode

public interface HierarchyNode

Interface for representatioon of a node in a hierarchy.

Method Summary

java.util.List<Entity>	getChildren() Gets all of the Entity objects that are child nodes of the entity to which this HierarchyNode is attached, following down the hierarchy.
java.util.List<Entity>	getChildren(java.util.Set<java.lang.String> entityTypes) Gets a filtered List of Entity objects that are children of the entity to which this HierarchyNode is attached, following down the hierarchy.
Entity	getEntity() Gets the Entity to which this HierarchyNode is attached.
java.lang.String	getHierarchyType() Gets the identifier of the hierarchy in which this node is a member.
Entity	getParentEntity() Gets the parent Entity of the entity to which this HierarchyNode is attached, following the hierarchy.
java.util.List<Entity>	getParents() Gets a List of all Entity objects that are parents of the entity to which this HierarchyNode is attached, following up the hierarchy (recursively).
boolean	hasChildren() Determines whether this HierarchyNode has children;
boolean	hasChildren(java.util.Set<java.lang.String> entityTypes) Determines whether this HierarchyNode has children of the specified entity types
boolean	hasParent() Determines if this HierarchyNode has a parent.
boolean	isActiveMember() Determines whether this HierarchyNode is in the "active" space of the hierarchy.
boolean	isRootArtifact() Determines whether this HierarchyNode is a hierarchy root artifact (absolute root, negative anchor or positive anchor).
boolean	mayHaveChildren() Determines whether this HierarchyNode may have children; if this returns true, it does not mean that there are children, just that there is a possibility.

Method Detail

getHierarchyType

java.lang.String getHierarchyType()

Gets the identifier of the hierarchy in which this node is a member.

Returns:

String representing the identifier of the hierarchy in which this node is a member.

getEntity

Entity getEntity()

Gets the Entity to which this HierarchyNode is attached.

Returns:

Entity to which this HierarchyNode is attached.

hasParent

boolean hasParent()

Determines if this HierarchyNode has a parent.

Returns:

Boolean true if this HierarchyNode has a parent, otherwise false.

getParentEntity

Entity getParentEntity()

Gets the parent Entity of the entity to which this HierarchyNode is attached, following the hierarchy.

Returns:

Entity representing the parent of the entity to which this HierarchyNode is attached, otherwise null if it has no parent.

mayHaveChildren

boolean mayHaveChildren()

Determines whether this HierarchyNode may have children; if this returns true, it does not mean that there are children, just that there is a possibility. If it returns false, there are definately no children, in other words, this is a leaf node.

Returns:

Boolean true if this HierarchyNode may have children, otherwise false if this is a leaf node.

hasChildren

boolean hasChildren()
                    throws ServerException

Determines whether this HierarchyNode has children;

Returns:

Boolean true if this HierarchyNode has children, otherwise false if this is a leaf node.

Throws:

ServerException - if there is an error looking up the child nodes.

hasChildren

boolean hasChildren(java.util.Set<java.lang.String> entityTypes)
                    throws ServerException

Determines whether this HierarchyNode has children of the specified entity types

Parameters:

entityTypes - Set of Strings representing entity types to be checked

Returns:

Boolean true if this HierarchyNode has children, otherwise false if this is a leaf node.

Throws:

ServerException - if there is an error looking up the child nodes.

getChildren

java.util.List<Entity> getChildren()
                                   throws ServerException

Gets all of the Entity objects that are child nodes of the entity to which this HierarchyNode is attached, following down the hierarchy.

Returns:

List of entities representing child nodes or an empty List if there are none.

Throws:

ServerException - if there is an error retrieving the child nodes.

getChildren

java.util.List<Entity> getChildren(java.util.Set<java.lang.String> entityTypes)
                                   throws ServerException

Gets a filtered List of Entity objects that are children of the entity to which this HierarchyNode is attached, following down the hierarchy.

Parameters:

entityTypes - Set of Strings representing entity types to be returned

Returns:

List of child nodes or an empty List if there are none.

Throws:

ServerException - if there is an error retrieving the children.

getParents

java.util.List<Entity> getParents()
                                  throws ServerException

Gets a List of all Entity objects that are parents of the entity to which this HierarchyNode is attached, following up the hierarchy (recursively).

Returns:

List of entities representing parent nodes or an empty List if there are none.

Throws:

ServerException - if there is an error retrieving the parents.

isActiveMember

boolean isActiveMember()

Determines whether this HierarchyNode is in the "active" space of the hierarchy.

Returns:

Boolean true if the node is in the "active" space of the hierarchy, otherwise false.

isRootArtifact

boolean isRootArtifact()

Determines whether this HierarchyNode is a hierarchy root artifact (absolute root, negative anchor or positive anchor).

Returns:

Boolean true if the node is a hierarchy root artifact, otherwise false.

Skip navigation links