Interface CatalogHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CatalogHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Catalogs . Each node in the hierarchy is a unique Catalog . The hierarchy may be traversed recursively to establish the tree structure through getParentCatalogs() and getChildCatalogs() . To relate these Ids to another OSID, getCatalogNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Catalog available in the Catalog OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentCatalogs() or getChildCatalogs() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: catalog elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessCatalogHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getCatalogHierarchy()	Gets the hierarchy associated with this session.
Id	getCatalogHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getCatalogNodeIds(Id catalogId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given catalog.
CatalogNode	getCatalogNodes(Id catalogId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given catalog.
IdList	getChildCatalogIds(Id catalogId)	Gets the child Ids of the given catalog.
CatalogList	getChildCatalogs(Id catalogId)	Gets the child catalogs of the given id .
IdList	getParentCatalogIds(Id catalogId)	Gets the parent Ids of the given catalog.
CatalogList	getParentCatalogs(Id catalogId)	Gets the parent catalogs of the given id .
IdList	getRootCatalogIds()	Gets the root catalog Ids in this hierarchy.
CatalogList	getRootCatalogs()	Gets the root catalogs in the catalog hierarchy.
boolean	hasChildCatalogs(Id catalogId)	Tests if a catalog has any children.
boolean	hasParentCatalogs(Id catalogId)	Tests if the Catalog has any parents.
boolean	isAncestorOfCatalog(Id id, Id catalogId)	Tests if an Id is an ancestor of a catalog.
boolean	isChildOfCatalog(Id id, Id catalogId)	Tests if a catalog is a direct child of another.
boolean	isDescendantOfCatalog(Id id, Id catalogId)	Tests if an Id is a descendant of a catalog.
boolean	isParentOfCatalog(Id id, Id catalogId)	Tests if an Id is a direct parent of a catalog.
void	useComparativeCatalogView()	The returns from the catalog methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCatalogView()	A complete view of the Catalog returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCatalogHierarchyId

Id getCatalogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogHierarchy

Hierarchy getCatalogHierarchy()
                       throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessCatalogHierarchy

boolean canAccessCatalogHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCatalogView

void useComparativeCatalogView()

The returns from the catalog methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCatalogView

void usePlenaryCatalogView()

A complete view of the Catalog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootCatalogIds

IdList getRootCatalogIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root catalog Ids in this hierarchy.

Returns:

the root catalog Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getRootCatalogs

CatalogList getRootCatalogs()
                     throws OperationFailedException,
PermissionDeniedException

Gets the root catalogs in the catalog hierarchy. A node with no parents is an orphan. While all catalog Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root catalogs

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentCatalogs

boolean hasParentCatalogs(Id catalogId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Catalog has any parents.

Parameters:

catalogId - a catalog Id

Returns:

true if the catalog has parents, false otherwise

Throws:

NotFoundException - catalogId is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

isParentOfCatalog

boolean isParentOfCatalog(Id id,
 Id catalogId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a catalog.

Parameters:

id - an Id

catalogId - the Id of a catalog

Returns:

true if this id is a parent of catalogId , false otherwise

Throws:

NotFoundException - catalogId is not found

NullArgumentException - id or catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentCatalogIds

IdList getParentCatalogIds(Id catalogId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given catalog.

Parameters:

catalogId - a catalog Id

Returns:

the parent Ids of the catalog

Throws:

NotFoundException - catalogId is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getParentCatalogs

CatalogList getParentCatalogs(Id catalogId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent catalogs of the given id .

Parameters:

catalogId - the Id of the Catalog to query

Returns:

the parent catalogs of the id

Throws:

NotFoundException - a Catalog identified by Id is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfCatalog

boolean isAncestorOfCatalog(Id id,
 Id catalogId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a catalog.

Parameters:

id - an Id

catalogId - the Id of a catalog

Returns:

true if this id is an ancestor of catalogId . false otherwise

Throws:

NotFoundException - catalogId not found

NullArgumentException - catalogId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildCatalogs

boolean hasChildCatalogs(Id catalogId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a catalog has any children.

Parameters:

catalogId - a catalogId

Returns:

true if the catalogId has children, false otherwise

Throws:

NotFoundException - catalogId is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfCatalog

boolean isChildOfCatalog(Id id,
 Id catalogId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a catalog is a direct child of another.

Parameters:

id - an Id

catalogId - the Id of a catalog

Returns:

true if the id is a child of catalogId , false otherwise

Throws:

NotFoundException - catalogId not found

NullArgumentException - catalogId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildCatalogIds

IdList getChildCatalogIds(Id catalogId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given catalog.

Parameters:

catalogId - the Id to query

Returns:

the children of the catalog

Throws:

NotFoundException - catalogId is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildCatalogs

CatalogList getChildCatalogs(Id catalogId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child catalogs of the given id .

Parameters:

catalogId - the Id of the Catalog to query

Returns:

the child catalogs of the id

Throws:

NotFoundException - a Catalog identified by Id is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfCatalog

boolean isDescendantOfCatalog(Id id,
 Id catalogId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a catalog.

Parameters:

id - an Id

catalogId - the Id of a catalog

Returns:

true if the id is a descendant of the catalogId , false otherwise

Throws:

NotFoundException - catalogId not found

NullArgumentException - catalogId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getCatalogNodeIds

Node getCatalogNodeIds(Id catalogId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given catalog.

Parameters:

catalogId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a catalog node

Throws:

NotFoundException - a Catalog identified by Id is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogNodes

CatalogNode getCatalogNodes(Id catalogId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given catalog.

Parameters:

catalogId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a catalog node

Throws:

NotFoundException - a Catalog identified by Id is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.