org.sakaiproject.hierarchy.model

Class HierarchyNode

java.lang.Object

org.sakaiproject.hierarchy.model.HierarchyNode

public class HierarchyNode
extends Object

This pea represents a node in a hierarchy (in academics a department or college would probably be represented by a node)

Author:

Aaron Zeckoski (aaronz@vt.edu)

Field Summary

Fields

Modifier and Type	Field and Description
Set<String>	childNodeIds a set of all children for this node
String	description the description for this node
Set<String>	directChildNodeIds a set of all direct children for this node, the ids of child nodes that touch this node directly
Set<String>	directParentNodeIds a set of all direct parents for this node, the ids of parent nodes that touch this node directly
String	hierarchyId The assigned unique id for the hierarchy this node is in
String	id The unique id for this hierarchy node
Boolean	isDisabled boolean representing whether or not node is disabled
Set<String>	parentNodeIds a set of all parents for this node
String	permToken the permissions token for the associated node, can be looked up in the permissions token key generator service
String	title the title of this node

Constructor Summary

Constructors

Constructor and Description
HierarchyNode() Empty constructor
HierarchyNode(String id, String hierarchyId, String title, String permToken, Set<String> directParentNodeIds, Set<String> parentNodeIds, Set<String> directChildNodeIds, Set<String> childNodeIds, Boolean isDisabled) Testing constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

public String id

The unique id for this hierarchy node

hierarchyId

public String hierarchyId

The assigned unique id for the hierarchy this node is in

title

public String title

the title of this node

description

public String description

the description for this node

permToken

public String permToken

the permissions token for the associated node, can be looked up in the permissions token key generator service

directParentNodeIds

public Set<String> directParentNodeIds

a set of all direct parents for this node, the ids of parent nodes that touch this node directly

directChildNodeIds

public Set<String> directChildNodeIds

a set of all direct children for this node, the ids of child nodes that touch this node directly

parentNodeIds

public Set<String> parentNodeIds

a set of all parents for this node

childNodeIds

public Set<String> childNodeIds

a set of all children for this node

isDisabled

public Boolean isDisabled

boolean representing whether or not node is disabled

Constructor Detail

HierarchyNode

public HierarchyNode()

Empty constructor

HierarchyNode

public HierarchyNode(String id,
                     String hierarchyId,
                     String title,
                     String permToken,
                     Set<String> directParentNodeIds,
                     Set<String> parentNodeIds,
                     Set<String> directChildNodeIds,
                     Set<String> childNodeIds,
                     Boolean isDisabled)

Testing constructor

Parameters:

id -

hierarchyId -

title -

permToken -

directParentNodeIds -

directChildNodeIds -

parentNodeIds -

childNodeIds -

isDisabled -

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object