OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyProxyManager
Implementsosid.OsidProxyManager
osid.hierarchy.HierarchyProfile
Description

The hierarchy manager provides access sessions to traverse and manage hierrachies of Ids. Methods in this manager accept a Proxy to pass information from server environments. 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
MethodgetHierarchyTraversalSession
Description

Gets the OsidSession associated with the hierarchy traversal service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyTraversalSessiona HierarchyTraversalSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyTraversal() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyTraversal() is true.
MethodgetHierarchyTraversalSessionForHierarchy
Description

Gets the OsidSession associated with the hierarchy traversal service for the given hierarchy.

Parametersosid.id.IdhierarchyIdthe Id of the hierarchy
osid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyTraversalSessiona HierarchyTraversalSession
ErrorsNOT_FOUND hierarchyid not found
NULL_ARGUMENT hierarchyId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHierarchyTraversal() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyTraversal() and supportsVisibleFederation() are true.
MethodgetHierarchyDesignSession
Description

Gets the OsidSession associated with the hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyDesignSessiona HierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyDesign() is true.
MethodgetHierarchyDesignSessionForHierarchy
Description

Gets the OsidSession associated with the topology design service using for the given hierarchy.

Parametersosid.id.IdhierarchyIdthe Id of the hierarchy
osid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyDesignSessiona HierarchyDesignSession
ErrorsNOT_FOUND hierarchyId is not found
NULL_ARGUMENT hierarchyId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyDesign() and supportsVisibleFederation() are true.
MethodgetHierarchySequencingSession
Description

Gets the OsidSession associated with the hierarchy sequencing service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchySequencingSessiona HierarchySequencingSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchySequencing() is false
ComplianceoptionalThis method must be implemented if supportsHierarchySequencing() is true.
MethodgetHierarchySequencingSessionForHierarchy
Description

Gets the OsidSession associated with the sequencing design service using for the given hierarchy.

Parametersosid.id.IdhierarchyIdthe Id of the graph
osid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchySequencingSessiona HierarchySequencingSession
ErrorsNOT_FOUND hierarchyId is not found
NULL_ARGUMENT hierarchyId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchySequencing() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHierarchySequencing() and supportsVisibleFederation() are true.
MethodgetHierarchyStructureNotificationSession
Description

Gets the session for subscribing to notifications of changes within a hierarchy structure.

Parametersosid.hierarchy.HierarchyStructureReceiverhierarchyStructureReceivera receiver
osid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyStructureNotificationSessiona HierarchyStructureNotificationSession
ErrorsNULL_ARGUMENT hierarchyStructureReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyStructureNotification() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyStructureNotification() is true.
MethodgetHierarchyStructureNotificationSessionForHierarchy
Description

Gets the session for subscribing to notifications of changes within a hierarchy structure for the given hierarchy.

Parametersosid.hierarchy.HierarchyStructureReceiverhierarchyStructureReceivera receiver
osid.id.IdhierarchyIdthe Id of the hierarchy
osid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyStructureNotificationSessiona HierarchyStructureNotificationSession
ErrorsNOT_FOUND hierarchyId is not found
NULL_ARGUMENT hierarchyStructureReceiver, hierarchyId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyStructureNotification() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyStructureNotification() and supportsVisibleFederation() are true.
MethodgetHierarchyLookupSession
Description

Gets the OsidSession associated with the hierarchy lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyLookupSessiona HierarchyLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyLookup() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyLookup() is true.
MethodgetHierarchyQuerySession
Description

Gets the OsidSession associated with the hierarchy query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyQuerySessiona HierarchyQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyQuery() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyQuery() is true.
MethodgetHierarchySearchSession
Description

Gets the OsidSession associated with the hierarchy search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchySearchSessiona HierarchySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchySearch() is false
ComplianceoptionalThis method must be implemented if supportsHierarchySearch() is true.
MethodgetHierarchyAdminSession
Description

Gets the hierarchy administrative session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyAdminSessiona HierarchyAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyAdmin() is true.
MethodgetHierarchyNotificationSession
Description

Gets the hierarchy notification session.

Parametersosid.hierarchy.HierarchyReceiverhierarchyReceivernotification callback
osid.proxy.Proxyproxya proxy
Returnosid.hierarchy.HierarchyNotificationSessiona HierarchyNotificationSession
ErrorsNULL_ARGUMENT hierarchyReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHierarchyNotification() is false
ComplianceoptionalThis method must be implemented if supportsHierarchyNotification() is true.