Interface CatalogueHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CatalogueHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Catalogues . Each node in the hierarchy is a unique Catalogue . The hierarchy may be traversed recursively to establish the tree structure through getParentCatalogues() and getChildCatalogues() . To relate these Ids to another OSID, getCatalogueNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Catalogue available in the Offering 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 getParentCatalogues() or getChildCatalogues() 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: catalogue 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	canAccessCatalogueHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getCatalogueHierarchy()	Gets the hierarchy associated with this session.
Id	getCatalogueHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getCatalogueNodeIds(Id catalogueId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given catalogue.
CatalogueNode	getCatalogueNodes(Id catalogueId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given catalogue.
IdList	getChildCatalogueIds(Id catalogueId)	Gets the child Ids of the given catalogue.
CatalogueList	getChildCatalogues(Id catalogueId)	Gets the child catalogues of the given id .
IdList	getParentCatalogueIds(Id catalogueId)	Gets the parent Ids of the given catalogue.
CatalogueList	getParentCatalogues(Id catalogueId)	Gets the parent catalogues of the given id .
IdList	getRootCatalogueIds()	Gets the root catalogue Ids in this hierarchy.
CatalogueList	getRootCatalogues()	Gets the root catalogues in the catalogue hierarchy.
boolean	hasChildCatalogues(Id catalogueId)	Tests if a catalogue has any children.
boolean	hasParentCatalogues(Id catalogueId)	Tests if the Catalogue has any parents.
boolean	isAncestorOfCatalogue(Id id, Id catalogueId)	Tests if an Id is an ancestor of a catalogue.
boolean	isChildOfCatalogue(Id id, Id catalogueId)	Tests if a catalogue is a direct child of another.
boolean	isDescendantOfCatalogue(Id id, Id catalogueId)	Tests if an Id is a descendant of a catalogue.
boolean	isParentOfCatalogue(Id id, Id catalogueId)	Tests if an Id is a direct parent of catalogue.
void	useComparativeCatalogueView()	The returns from the catalogue methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCatalogueView()	A complete view of the Catalogue 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

getCatalogueHierarchyId

Id getCatalogueHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogueHierarchy

Hierarchy getCatalogueHierarchy()
                         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.

canAccessCatalogueHierarchy

boolean canAccessCatalogueHierarchy()

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.

useComparativeCatalogueView

void useComparativeCatalogueView()

The returns from the catalogue 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.

usePlenaryCatalogueView

void usePlenaryCatalogueView()

A complete view of the Catalogue 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.

getRootCatalogueIds

IdList getRootCatalogueIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root catalogue Ids in this hierarchy.

Returns:

the root catalogue Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootCatalogues

CatalogueList getRootCatalogues()
                         throws OperationFailedException,
PermissionDeniedException

Gets the root catalogues in the catalogue hierarchy. A node with no parents is an orphan. While all catalogue 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 catalogues

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentCatalogues

boolean hasParentCatalogues(Id catalogueId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Catalogue has any parents.

Parameters:

catalogueId - a catalogue Id

Returns:

true if the catalogue has parents, f alse otherwise

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfCatalogue

boolean isParentOfCatalogue(Id id,
 Id catalogueId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of catalogue.

Parameters:

id - an Id

catalogueId - the Id of a catalogue

Returns:

true if this id is a parent of catalogueId , f alse otherwise

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - id or catalogueId 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} .

getParentCatalogueIds

IdList getParentCatalogueIds(Id catalogueId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given catalogue.

Parameters:

catalogueId - a catalogue Id

Returns:

the parent Ids of the catalogue

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentCatalogues

CatalogueList getParentCatalogues(Id catalogueId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent catalogues of the given id .

Parameters:

catalogueId - the Id of the Catalogue to query

Returns:

the parent catalogues of the id

Throws:

NotFoundException - a Catalogue identified by Id is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfCatalogue

boolean isAncestorOfCatalogue(Id id,
 Id catalogueId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a catalogue.

Parameters:

id - an Id

catalogueId - the Id of a catalogue

Returns:

true if this id is an ancestor of catalogueId , false otherwise

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - id or catalogueId 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} .

hasChildCatalogues

boolean hasChildCatalogues(Id catalogueId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a catalogue has any children.

Parameters:

catalogueId - a catalogue Id

Returns:

true if the catalogueId has children, false otherwise

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - bocatalogueId is null okId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfCatalogue

boolean isChildOfCatalogue(Id id,
 Id catalogueId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a catalogue is a direct child of another.

Parameters:

id - an Id

catalogueId - the Id of a catalogue

Returns:

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

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - id or catalogueId 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} .

getChildCatalogueIds

IdList getChildCatalogueIds(Id catalogueId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given catalogue.

Parameters:

catalogueId - the Id to query

Returns:

the children of the catalogue

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildCatalogues

CatalogueList getChildCatalogues(Id catalogueId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child catalogues of the given id .

Parameters:

catalogueId - the Id of the Catalogue to query

Returns:

the child catalogues of the id

Throws:

NotFoundException - a Catalogue identified by Id is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfCatalogue

boolean isDescendantOfCatalogue(Id id,
 Id catalogueId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a catalogue.

Parameters:

id - an Id

catalogueId - the Id of a catalogue

Returns:

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

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - id or catalogueId 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} .

getCatalogueNodeIds

Node getCatalogueNodeIds(Id catalogueId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given catalogue.

Parameters:

catalogueId - 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 catalogue node

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueNodes

CatalogueNode getCatalogueNodes(Id catalogueId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given catalogue.

Parameters:

catalogueId - 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 catalogue node

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.