org.osid.hierarchy

Interface HierarchyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HierarchyProfile, OsidManager, OsidProfile, Sourceable

public interface HierarchyManager
extends OsidManager, HierarchyProfile

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 Summary

Methods

Modifier and Type	Method and Description
HierarchyAdminSession	getHierarchyAdminSession() Gets the hierarchy administrative session.
HierarchyDesignSession	getHierarchyDesignSession() Gets the OsidSession associated with the hierarchy design service.
HierarchyDesignSession	getHierarchyDesignSessionForHierarchy(Id hierarchyId) Gets the OsidSession associated with the topology design service using for the given hierarchy.
HierarchyLookupSession	getHierarchyLookupSession() Gets the OsidSession associated with the hierarchy lookup service.
HierarchyNotificationSession	getHierarchyNotificationSession(HierarchyReceiver hierarchyReceiver) Gets a hierarchy notification session.
HierarchyQuerySession	getHierarchyQuerySession() Gets the OsidSession associated with the hierarchy query service.
HierarchySearchSession	getHierarchySearchSession() Gets the OsidSession associated with the hierarchy search service.
HierarchySequencingSession	getHierarchySequencingSession() Gets the OsidSession associated with the hierarchy sequencing service.
HierarchySequencingSession	getHierarchySequencingSessionForHierarchy(Id hierarchyId) Gets the OsidSession associated with the sequencing design service using for the given hierarchy.
HierarchyStructureNotificationSession	getHierarchyStructureNotificationSession(HierarchyStructureReceiver hierarchyStructureReceiver) Gets the session for subscribing to notifications of changes within a hierarchy structure.
HierarchyStructureNotificationSession	getHierarchyStructureNotificationSessionForHierarchy(HierarchyStructureReceiver hierarchyStructureReceiver, Id hierarchyId) Gets the session for subscribing to notifications of changes within a hierarchy structure for the given hierarchy.
HierarchyTraversalSession	getHierarchyTraversalSession() Gets the OsidSession associated with the hierarchy traversal service.
HierarchyTraversalSession	getHierarchyTraversalSessionForHierarchy(Id hierarchyId) Gets the OsidSession associated with the hierarchy traversal service for the given hierarchy.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.hierarchy.HierarchyProfile

getHierarchyRecordTypes, getHierarchySearchRecordTypes, supportsHierarchyAdmin, supportsHierarchyDesign, supportsHierarchyLookup, supportsHierarchyNotification, supportsHierarchyQuery, supportsHierarchyRecordType, supportsHierarchySearch, supportsHierarchySearchRecordType, supportsHierarchySequencing, supportsHierarchyStructureNotification, supportsHierarchyTraversal, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getHierarchyTraversalSession

HierarchyTraversalSession getHierarchyTraversalSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the hierarchy traversal service.

Returns:

a HierarchyTraversalSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyTraversal() is false

Compliance:

optional - This method must be implemented if supportsHierarchyTraversal() is true.

getHierarchyTraversalSessionForHierarchy

HierarchyTraversalSession getHierarchyTraversalSessionForHierarchy(Id hierarchyId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

hierarchyId - the Id of the hierarchy

Returns:

the new HierarchyTraversalSession

Throws:

NotFoundException - hierarchyId not found

NullArgumentException - hierarchyid is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyTraversal() or supportsVisibleFedaration() is false

Compliance:

optional - This method must be implemented if supportsHierarchyTraversal() and supportsVisibleFederation() are true.

getHierarchyDesignSession

HierarchyDesignSession getHierarchyDesignSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the hierarchy design service.

Returns:

a HierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsHierarchyDesign() is true.

getHierarchyDesignSessionForHierarchy

HierarchyDesignSession getHierarchyDesignSessionForHierarchy(Id hierarchyId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

hierarchyId - the Id of the graph

Returns:

a HierarchyDesignSession

Throws:

NotFoundException - hierarchyId is not found

NullArgumentException - hierarchyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsHierarchyDesign() and supportsVisibleFederation() are true.

getHierarchySequencingSession

HierarchySequencingSession getHierarchySequencingSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the hierarchy sequencing service.

Returns:

a HierarchySequencingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchySequencing() is false

Compliance:

optional - This method must be implemented if supportsHierarchySequencing() is true.

getHierarchySequencingSessionForHierarchy

HierarchySequencingSession getHierarchySequencingSessionForHierarchy(Id hierarchyId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

hierarchyId - the Id of the graph

Returns:

a HierarchySequencingSession

Throws:

NotFoundException - hierarchyId is not found

NullArgumentException - hierarchyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchySequencing() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsHierarchySequencing() and supportsVisibleFederation() are true.

getHierarchyStructureNotificationSession

HierarchyStructureNotificationSession getHierarchyStructureNotificationSession(HierarchyStructureReceiver hierarchyStructureReceiver)
                                                                               throws OperationFailedException

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

Parameters:

hierarchyStructureReceiver - a receiver

Returns:

a HierarchyStructureNotificationSession

Throws:

NullArgumentException - hierarchyStructureReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyStructureNotification() is false

Compliance:

optional - This method must be implemented if supportsHierarchyStructureNotification() is true.

getHierarchyStructureNotificationSessionForHierarchy

HierarchyStructureNotificationSession getHierarchyStructureNotificationSessionForHierarchy(HierarchyStructureReceiver hierarchyStructureReceiver,
                                                                                         Id hierarchyId)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

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

Parameters:

hierarchyStructureReceiver - a receiver

hierarchyId - the Id of the graph

Returns:

a HierarchyStructureNotificationSession

Throws:

NotFoundException - hierarchyId is not found

NullArgumentException - hierarchyStructureReceiver or hierarchyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyStructureNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsHierarchyStructureNotification() and supportsVisibleFederation() are true.

getHierarchyLookupSession

HierarchyLookupSession getHierarchyLookupSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the hierarchy lookup service.

Returns:

a HierarchyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyLookup() is false

Compliance:

optional - This method must be implemented if supportsHierarchyLookup() is true.

getHierarchyQuerySession

HierarchyQuerySession getHierarchyQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the hierarchy query service.

Returns:

a HierarchyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyQuery() is false

Compliance:

optional - This method must be implemented if supportsHierarchyQuery() is true.

getHierarchySearchSession

HierarchySearchSession getHierarchySearchSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the hierarchy search service.

Returns:

a HierarchySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchySearch() is false

Compliance:

optional - This method must be implemented if supportsHierarchySearch() is true.

getHierarchyAdminSession

HierarchyAdminSession getHierarchyAdminSession()
                                               throws OperationFailedException

Gets the hierarchy administrative session.

Returns:

a HierarchyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyAdmin() is false

Compliance:

optional - This method must be implemented if supportsHierarchyAdmin() is true.

getHierarchyNotificationSession

HierarchyNotificationSession getHierarchyNotificationSession(HierarchyReceiver hierarchyReceiver)
                                                             throws OperationFailedException

Gets a hierarchy notification session.

Parameters:

hierarchyReceiver - notification callback

Returns:

a HierarchyNotificationSession

Throws:

NullArgumentException - hierarchyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHierarchyNotification() is false

Compliance:

optional - This method must be implemented if supportsHierarchyNotification() is true.