OSID - osid.hierarchy.HierarchyManager Service Interface Definition

Interface	osid.hierarchy.HierarchyManager
Implements	`osid.OsidManager`
Implements	`osid.hierarchy.HierarchyProfile`
Description	The hierarchy manager provides access sessions to traverse and manage hierrachies of `Ids.` The sessions included in this manager are: `HierarchyTraversalSession:` a basic session traversing a hierarchy `HierarchyDesignSession:` a session to design a hierarchy `HierarchySequencingSession:` a session to sequence nodes in a hierarchy `HierarchyStructureNotificationSession:` a session for notififcations within a hierarchy structure `HierarchyLookupSession:` a session looking up hiererachies `HierarchyQuerySession:` a session querying hiererachies `HierarchySearchSession:` a session for searching for hierarchies `HierarchyAdminSession:` a session for creating and deleting hierarchies `HierarchyNotificationSession:` a session for subscribing to changes in hierarchies
Method	getHierarchyTraversalSession
Description	Gets the `OsidSession` associated with the hierarchy traversal service.
Return	`osid.hierarchy.HierarchyTraversalSession`		a `HierarchyTraversalSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchyTraversal()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyTraversal()` is `true.`
Method	getHierarchyTraversalSessionForHierarchy
Description	Gets the `OsidSession` associated with the hierarchy traversal service for the given hierarchy.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the hierarchy
Return	`osid.hierarchy.HierarchyTraversalSession`		the new `HierarchyTraversalSession`
Errors	NOT_FOUND		`hierarchyId` not found
	NULL_ARGUMENT		`hierarchyid` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsHierarchyTraversal()` or `supportsVisibleFedaration()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyTraversal()` and `supportsVisibleFederation()` are `true.`
Method	getHierarchyDesignSession
Description	Gets the `OsidSession` associated with the hierarchy design service.
Return	`osid.hierarchy.HierarchyDesignSession`		a `HierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyDesign()` is `true.`
Method	getHierarchyDesignSessionForHierarchy
Description	Gets the `OsidSession` associated with the topology design service using for the given hierarchy.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the graph
Return	`osid.hierarchy.HierarchyDesignSession`		a `HierarchyDesignSession`
Errors	NOT_FOUND		`hierarchyId` is not found
	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHierarchyDesign()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyDesign()` and `supportsVisibleFederation()` are `true.`
Method	getHierarchySequencingSession
Description	Gets the `OsidSession` associated with the hierarchy sequencing service.
Return	`osid.hierarchy.HierarchySequencingSession`		a `HierarchySequencingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchySequencing()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchySequencing()` is `true.`
Method	getHierarchySequencingSessionForHierarchy
Description	Gets the `OsidSession` associated with the sequencing design service using for the given hierarchy.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the graph
Return	`osid.hierarchy.HierarchySequencingSession`		a `HierarchySequencingSession`
Errors	NOT_FOUND		`hierarchyId` is not found
	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHierarchySequencing()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchySequencing()` and `supportsVisibleFederation()` are `true.`
Method	getHierarchyStructureNotificationSession
Description	Gets the session for subscribing to notifications of changes within a hierarchy structure.
Parameters	`osid.hierarchy.HierarchyStructureReceiver`	`hierarchyStructureReceiver`	a receiver
Return	`osid.hierarchy.HierarchyStructureNotificationSession`		a `HierarchyStructureNotificationSession`
Errors	NULL_ARGUMENT		`hierarchyStructureReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHierarchyStructureNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyStructureNotification()` is `true.`
Method	getHierarchyStructureNotificationSessionForHierarchy
Description	Gets the session for subscribing to notifications of changes within a hierarchy structure for the given hierarchy.
Parameters	`osid.hierarchy.HierarchyStructureReceiver`	`hierarchyStructureReceiver`	a receiver
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the graph
Return	`osid.hierarchy.HierarchyStructureNotificationSession`		a `HierarchyStructureNotificationSession`
Errors	NOT_FOUND		`hierarchyId` is not found
	NULL_ARGUMENT		`hierarchyStructureReceiver` or `hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHierarchyStructureNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyStructureNotification()` and `supportsVisibleFederation()` are `true.`
Method	getHierarchyLookupSession
Description	Gets the `OsidSession` associated with the hierarchy lookup service.
Return	`osid.hierarchy.HierarchyLookupSession`		a `HierarchyLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchyLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyLookup()` is `true.`
Method	getHierarchyQuerySession
Description	Gets the `OsidSession` associated with the hierarchy query service.
Return	`osid.hierarchy.HierarchyQuerySession`		a `HierarchyQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyQuery()` is `true.`
Method	getHierarchySearchSession
Description	Gets the `OsidSession` associated with the hierarchy search service.
Return	`osid.hierarchy.HierarchySearchSession`		a `HierarchySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchySearch()` is `true.`
Method	getHierarchyAdminSession
Description	Gets the hierarchy administrative session.
Return	`osid.hierarchy.HierarchyAdminSession`		a `HierarchyAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsHierarchyAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyAdmin()` is `true.`
Method	getHierarchyNotificationSession
Description	Gets a hierarchy notification session.
Parameters	`osid.hierarchy.HierarchyReceiver`	`hierarchyReceiver`	notification callback
Return	`osid.hierarchy.HierarchyNotificationSession`		a `HierarchyNotificationSession`
Errors	NULL_ARGUMENT		`hierarchyReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHierarchyNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHierarchyNotification()` is `true.`