Interface HierarchyManager

All Superinterfaces:

AutoCloseable, Closeable, HierarchyProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface HierarchyProfile

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

Modifier and Type	Method	Description
TypeList	getHierarchyRecordTypes()	Gets the supported Hierarchy types.
TypeList	getHierarchySearchRecordTypes()	Gets the supported Hierarchy search record types.
boolean	supportsHierarchyAdmin()	Tests if a hierarchy administration is supported.
boolean	supportsHierarchyDesign()	Tests if hierarchy design is supported.
boolean	supportsHierarchyLookup()	Tests if a hierarchy lookup is supported.
boolean	supportsHierarchyNotification()	Tests if hierarchy notification is supported.
boolean	supportsHierarchyQuery()	Tests if a hierarchy query is supported.
boolean	supportsHierarchyRecordType(Type hierarchyRecordType)	Tests if the given Hierarchy record type is supported.
boolean	supportsHierarchySearch()	Tests if a hierarchy search is supported.
boolean	supportsHierarchySearchRecordType(Type hierarchySearchRecordType)	Tests if the given Hierarchy search record type is supported.
boolean	supportsHierarchySequencing()	Tests if hierarchy sequencing is supported.
boolean	supportsHierarchyStructureNotification()	Tests if hierarchy structure notification is supported.
boolean	supportsHierarchyTraversal()	Tests if hierarchy traversal is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids.
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsHierarchyTraversal()} is {@code 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 {@code supportsHierarchyTraversal()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsHierarchyDesign()} is {@code 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 {@code supportsHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsHierarchySequencing()} is {@code 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 {@code supportsHierarchySequencing()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsHierarchyStructureNotification()} is {@code 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 {@code supportsHierarchyStructureNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsHierarchyLookup()} is {@code 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 {@code supportsHierarchyQuery()} is {@code 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 {@code supportsHierarchySearch()} is {@code 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 {@code supportsHierarchyAdmin()} is {@code 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 {@code supportsHierarchyNotification()} is {@code true}.