Class HierarchyManager

Description
Description | Descendents | Methods (details)

<p> HierarchyManager handles creating, deleting, and getting Hierarchies.

</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/hierarchy/HierarchyManager.php (line 39) 

OsidManager
   |
   --HierarchyManager
Direct descendents
Description | Descendents | Methods (details)
Class Description
HarmoniHierarchyManager <p> HierarchyManager handles creating, deleting, and getting Hierarchies.
Method Summary
Description | Descendents | Methods (details)
object Hierarchy createHierarchy (string $displayName, object Type[] $nodeTypes, string $description, boolean $allowsMultipleParents, mixed $allowsRecursion, boolean $allowsRecursion )
void deleteHierarchy (mixed $hierarchyId, object Id $hierarchyId )
object HierarchyIterator getHierarchies ()
object Hierarchy getHierarchy (mixed $hierarchyId, object Id $hierarchyId )
boolean supportsMaintenance ()
Methods
Description | Descendents | Methods (details)
createHierarchy (line 71)

Create a Hierarchy.

  • 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, UNSUPPORTED_CREATION
object Hierarchy createHierarchy (string $displayName, object Type[] $nodeTypes, string $description, boolean $allowsMultipleParents, mixed $allowsRecursion, boolean $allowsRecursion )
  • string $displayName
  • object Type[] $nodeTypes
  • string $description
  • boolean $allowsMultipleParents
  • boolean $allowsRecursion
Redefined in descendants as:
deleteHierarchy (line 153)

Delete a Hierarchy by unique Id. All Nodes must be removed from the Hierarchy before this method is called.

  • 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, HIERARCHY_NOT_EMPTY
void deleteHierarchy (mixed $hierarchyId, object Id $hierarchyId )
Redefined in descendants as:
getHierarchies (line 123)

Get all Hierarchies.

  • 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 HierarchyIterator getHierarchies ()
Redefined in descendants as:
getHierarchy (line 100)

Get a Hierarchy by 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, NODE_TYPE_NOT_FOUND
object Hierarchy getHierarchy (mixed $hierarchyId, object Id $hierarchyId )
Redefined in descendants as:
supportsMaintenance (line 180)

This method indicates whether this implementation supports

HierarchyManager methods: createHierarchy, deleteHierarchy, updateName, updateDescription, createRootNode, createNode, deleteNode, addNodeType, removeNodeType. Note methods: nodeUpdateDescription, noteUpdateDisplayName, addParent, removeParent, changeParent.

  • 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 supportsMaintenance ()
Redefined in descendants as:

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

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