Docs For Class Node

Class Node

Description

Node is a Hierarchy's representation of an external object that is one of a number of similar objects to be organized. Nodes must be connected to a Hierarchy.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/hierarchy/Node.php (line 19)

Direct descendents

Class	Description
HarmoniNode	Node is a Hierarchy's representation of an external object that is one of a number of similar objects to be organized. Nodes must be connected to a Hierarchy.

Method Summary

void addParent (mixed $nodeId, object Id $nodeId )

void changeParent (object Id $oldParentId, mixed $newParentId, object Id $newParentId )

object NodeIterator getChildren ()

string getDescription ()

string getDisplayName ()

object Id getId ()

object NodeIterator getParents ()

object Type getType ()

boolean isLeaf ()

boolean isRoot ()

void removeParent (mixed $parentId, object Id $parentId )

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

Methods

addParent (line 288)

Link a parent to this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, NODE_TYPE_NOT_FOUND, SINGLE_PARENT_HIERARCHY, ALREADY_ADDED, ATTEMPTED_RECURSION

void addParent (mixed $nodeId, object Id $nodeId )

object Id $nodeId

Redefined in descendants as:

HarmoniNode::addParent() : Link a parent to this Node.

changeParent (line 350)

Changes the parent of this Node by adding a new parent and removing the old parent.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, NODE_TYPE_NOT_FOUND, ATTEMPTED_RECURSION

void changeParent (object Id $oldParentId, mixed $newParentId, object Id $newParentId )

object Id $oldParentId
object Id $newParentId

Redefined in descendants as:

HarmoniNode::changeParent() : Changes the parent of this Node by adding a new parent and removing the old parent.

getChildren (line 134)

Get the children of this Node. To get other descendants use the Hierarchy traverse method.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object NodeIterator getChildren ()

Redefined in descendants as:

HarmoniNode::getChildren() : Get the children of this Node. To get other descendants use the Hierarchy traverse method.

getDescription (line 86)

Get the description for this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDescription ()

Redefined in descendants as:

HarmoniNode::getDescription() : Get the description for this Node.

getDisplayName (line 63)

Get the display name for this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

Redefined in descendants as:

HarmoniNode::getDisplayName() : Get the display name for this Node.

getId (line 40)

Get the unique Id for this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

Redefined in descendants as:

HarmoniNode::getId() : Get the unique Id for this Node.

getParents (line 110)

Get the parents of this Node. To get other ancestors use the Hierarchy traverse method.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object NodeIterator getParents ()

Redefined in descendants as:

HarmoniNode::getParents() : Get the parents of this Node. To get other ancestors use the Hierarchy traverse method.

getType (line 157)

Get the Type for this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getType ()

Redefined in descendants as:

HarmoniNode::getType() : Get the Type for this Node.

isLeaf (line 232)

Return true if this Node is a leaf; false otherwise. A Node is a leaf if it has no children.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

boolean isLeaf ()

Redefined in descendants as:

HarmoniNode::isLeaf() : Return true if this Node is a leaf; false otherwise. A Node is a leaf if it has no children.

isRoot (line 255)

Return true if this Node is a root; false otherwise.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

boolean isRoot ()

Redefined in descendants as:

HarmoniNode::isRoot() : Return true if this Node is a root; false otherwise.

removeParent (line 319)

Unlink a parent from this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, NODE_TYPE_NOT_FOUND, SINGLE_PARENT_HIERARCHY, INCONSISTENT_STATE

void removeParent (mixed $parentId, object Id $parentId )

object Id $parentId

Redefined in descendants as:

HarmoniNode::removeParent() : Unlink a parent from this Node.

updateDescription (line 182)

Update the description of this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

Redefined in descendants as:

HarmoniNode::updateDescription() : Update the description of this Node.

updateDisplayName (line 208)

Update the name of this Node. Node name changes are permitted since the Hierarchy's integrity is based on the Node's unique Id.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefined in descendants as:

HarmoniNode::updateDisplayName() : Update the name of this Node. Node name changes are permitted since the Hierarchy's integrity is based on the Node's unique Id.

Documentation generated on Wed, 19 Sep 2007 10:25:16 -0400 by phpDocumentor 1.3.0RC3