org.sakaiproject.hierarchy

Interface HierarchyNodeWriter

All Known Subinterfaces:

HierarchyService

public interface HierarchyNodeWriter

Allows user to control nodes (create, update, remove)

Author:

Aaron Zeckoski (aaronz@vt.edu)

Method Summary

Modifier and Type	Method and Description
HierarchyNode	addChildRelation(String nodeId, String childNodeId) Add children to a node (creates the association), only adds direct children (directly connected to this node), others are implicitly defined, this will not create loops in the hierarchy
HierarchyNode	addNode(String hierarchyId, String parentNodeId) Add a new node to a hierarchy
HierarchyNode	addParentRelation(String nodeId, String parentNodeId) Add parents to a node (creates the association), only adds direct parents (directly connected to this node), others are implicitly defined, this will not create loops in the hierarchy
HierarchyNode	removeChildRelation(String nodeId, String childNodeId) Remove a child relation from a node, this will not be allowed to orphan a node
HierarchyNode	removeNode(String nodeId) Remove a node from the hierarchy if it is possible, nodes can only be removed if they have no children associations, root nodes can never be removed, exception occurs if these rules are violated
HierarchyNode	removeParentRelation(String nodeId, String parentNodeId) Remove a parent relation from a node, this will not be allowed to orphan a node, only extra parents may be removed, the last parent for a node cannot currently be removed
HierarchyNode	saveNodeMetaData(String nodeId, String title, String description, String permKey) Save meta data on a node, this is optional and nodes do not need meta data associated, if the params are nulls then the values remain unchanged, if they are empty string then the values are wiped out
HierarchyNode	setNodeDisabled(String nodeId, Boolean isDisabled) Enables/disables the node.

Method Detail

addNode

HierarchyNode addNode(String hierarchyId,
                      String parentNodeId)

Add a new node to a hierarchy

Parameters:

hierarchyId - a unique id which defines the hierarchy

parentNodeId - the unique id for the parent of this node, can be null if this is the root or a top level node

Returns:

the object representing the newly added node

removeNode

HierarchyNode removeNode(String nodeId)

Remove a node from the hierarchy if it is possible, nodes can only be removed if they have no children associations, root nodes can never be removed, exception occurs if these rules are violated

Parameters:

nodeId - a unique id for a hierarchy node

Returns:

the object representing the parent of the removed node

addParentRelation

HierarchyNode addParentRelation(String nodeId,
                                String parentNodeId)

Add parents to a node (creates the association), only adds direct parents (directly connected to this node), others are implicitly defined,
this will not create loops in the hierarchy

Parameters:

nodeId - a unique id for a hierarchy node

parentNodeId - a unique id for a hierarchy node which will be a parent of this node

Returns:

the object representing the updated node

addChildRelation

HierarchyNode addChildRelation(String nodeId,
                               String childNodeId)

Add children to a node (creates the association), only adds direct children (directly connected to this node), others are implicitly defined,
this will not create loops in the hierarchy

Parameters:

nodeId - a unique id for a hierarchy node

childNodeId - a unique id for a hierarchy node which will be a child of this node

Returns:

the object representing the updated node

removeParentRelation

HierarchyNode removeParentRelation(String nodeId,
                                   String parentNodeId)

Remove a parent relation from a node, this will not be allowed to orphan a node, only extra parents may be removed, the last parent for a node cannot currently be removed

Parameters:

nodeId - a unique id for a hierarchy node

parentNodeId - a unique id for a hierarchy node which is a parent of this node

Returns:

the object representing the updated node

removeChildRelation

HierarchyNode removeChildRelation(String nodeId,
                                  String childNodeId)

Remove a child relation from a node, this will not be allowed to orphan a node

Parameters:

nodeId - a unique id for a hierarchy node

childNodeId - a unique id for a hierarchy node which is a child of this node

Returns:

the object representing the updated node

saveNodeMetaData

HierarchyNode saveNodeMetaData(String nodeId,
                               String title,
                               String description,
                               String permKey)

Save meta data on a node, this is optional and nodes do not need meta data associated, if the params are nulls then the values remain unchanged, if they are empty string then the values are wiped out

Parameters:

nodeId - a unique id for a hierarchy node

title - the title of the node (optional)

description - a description for this node (optional)

permKey - the permission token key associated with this node (optional)

Returns:

the object representing the updated node

setNodeDisabled

HierarchyNode setNodeDisabled(String nodeId,
                              Boolean isDisabled)

Enables/disables the node. This is used when a user updates the hierarchy but wishes to retain any links to the node until they can be properly updated as well.

Parameters:

nodeId - a unique id for a hierarchy node

isDisabled - Boolean representing the state the node will be set to

Returns:

the object representing the updated node