Interface CourseCatalogHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CourseCatalogHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of CourseCatalogs . Each node in the hierarchy is a unique CourseCatalog . The hierarchy may be traversed recursively to establish the tree structure through getParentCourseCatalogs() and getChildCourseCatalogs() . To relate these Ids to another OSID, getCourseCatalogNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any CourseCatalog available in the Course 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 getParentCourseCatalogs() or getChildCourseCatalog() 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: course 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	canAccessCourseCatalogHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildCourseCatalogIds(Id courseCatalogId)	Gets the child Ids of the given course catalog.
CourseCatalogList	getChildCourseCatalogs(Id courseCatalogId)	Gets the children of the given course catalog.
Hierarchy	getCourseCatalogHierarchy()	Gets the hierarchy associated with this session.
Id	getCourseCatalogHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getCourseCatalogNodeIds(Id courseCatalogId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given course catalog.
CourseCatalogNode	getCourseCatalogNodes(Id courseCatalogId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given course catalog.
IdList	getParentCourseCatalogIds(Id courseCatalogId)	Gets the parent Ids of the given course catalog.
CourseCatalogList	getParentCourseCatalogs(Id courseCatalogId)	Gets the parents of the given course catalog.
IdList	getRootCourseCatalogIds()	Gets the root course catalog Ids in this hierarchy.
CourseCatalogList	getRootCourseCatalogs()	Gets the root course catalogs in the course catalog hierarchy.
boolean	hasChildCourseCatalogs(Id courseCatalogId)	Tests if a course catalog has any children.
boolean	hasParentCourseCatalogs(Id courseCatalogId)	Tests if the CourseCatalog has any parents.
boolean	isAncestorOfCourseCatalog(Id id, Id courseCatalogId)	Tests if an Id is an ancestor of a course catalog.
boolean	isChildOfCourseCatalog(Id id, Id courseCatalogId)	Tests if a course catalog is a direct child of another.
boolean	isDescendantOfCourseCatalog(Id id, Id courseCatalogId)	Tests if an Id is a descendant of a course catalog.
boolean	isParentOfCourseCatalog(Id id, Id courseCatalogId)	Tests if an Id is a direct parent of course catalog.
void	useComparativeCourseCatalogView()	The returns from the course catalog methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCourseCatalogView()	A complete view of the CourseCatalogs 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

getCourseCatalogHierarchyId

Id getCourseCatalogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalogHierarchy

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

canAccessCourseCatalogHierarchy

boolean canAccessCourseCatalogHierarchy()

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.

useComparativeCourseCatalogView

void useComparativeCourseCatalogView()

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

usePlenaryCourseCatalogView

void usePlenaryCourseCatalogView()

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

getRootCourseCatalogIds

IdList getRootCourseCatalogIds()
                        throws OperationFailedException,
PermissionDeniedException

Gets the root course catalog Ids in this hierarchy.

Returns:

the root catalog Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootCourseCatalogs

CourseCatalogList getRootCourseCatalogs()
                                 throws OperationFailedException,
PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentCourseCatalogs

boolean hasParentCourseCatalogs(Id courseCatalogId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the CourseCatalog has any parents.

Parameters:

courseCatalogId - a catalog Id

Returns:

true if the catalog has parents, f alse otherwise

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfCourseCatalog

boolean isParentOfCourseCatalog(Id id,
 Id courseCatalogId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

courseCatalogId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - courseCatalogId is not found

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

getParentCourseCatalogIds

IdList getParentCourseCatalogIds(Id courseCatalogId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given course catalog.

Parameters:

courseCatalogId - a catalog Id

Returns:

the parent Ids of the catalog

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentCourseCatalogs

CourseCatalogList getParentCourseCatalogs(Id courseCatalogId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given course catalog.

Parameters:

courseCatalogId - the Id to query

Returns:

the parents of the course catalog

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfCourseCatalog

boolean isAncestorOfCourseCatalog(Id id,
 Id courseCatalogId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a course catalog.

Parameters:

id - an Id

courseCatalogId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId 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} .

hasChildCourseCatalogs

boolean hasChildCourseCatalogs(Id courseCatalogId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a course catalog has any children.

Parameters:

courseCatalogId - a course catalog Id

Returns:

true if the courseCatalogId has children, false otherwise

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfCourseCatalog

boolean isChildOfCourseCatalog(Id id,
 Id courseCatalogId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a course catalog is a direct child of another.

Parameters:

id - an Id

courseCatalogId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - courseCatalogId not found

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

getChildCourseCatalogIds

IdList getChildCourseCatalogIds(Id courseCatalogId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given course catalog.

Parameters:

courseCatalogId - the Id to query

Returns:

the children of the catalog

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildCourseCatalogs

CourseCatalogList getChildCourseCatalogs(Id courseCatalogId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given course catalog.

Parameters:

courseCatalogId - the Id to query

Returns:

the children of the course catalog

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfCourseCatalog

boolean isDescendantOfCourseCatalog(Id id,
 Id courseCatalogId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a course catalog.

Parameters:

id - an Id

courseCatalogId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - courseCatalogId not found

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

getCourseCatalogNodeIds

Node getCourseCatalogNodeIds(Id courseCatalogId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given course catalog.

Parameters:

courseCatalogId - 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 - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogNodes

CourseCatalogNode getCourseCatalogNodes(Id courseCatalogId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given course catalog.

Parameters:

courseCatalogId - 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 - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.