Interface GradebookHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GradebookHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Gradebook objects. Each node in the hierarchy is a unique Gradebook . The hierarchy may be traversed recursively to establish the tree structure through getParentGradebooks() and getChildGradebooks() . To relate these Ids to another OSID, getGradebookNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Gradebook available in the Gradebooking 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 getParentGradebooks() or getChildGradebooks() 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: gradebook 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	canAccessGradebookHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildGradebookIds(Id gradebookId)	Gets the child Ids of the given gradebook.
GradebookList	getChildGradebooks(Id gradebookId)	Gets the children of the given gradebook.
Hierarchy	getGradebookHierarchy()	Gets the hierarchy associated with this session.
Id	getGradebookHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getGradebookNodeIds(Id gradebookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given gradebook.
GradebookNode	getGradebookNodes(Id gradebookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given gradebook.
IdList	getParentGradebookIds(Id gradebookId)	Gets the parent Ids of the given gradebook.
GradebookList	getParentGradebooks(Id gradebookId)	Gets the parents of the given gradebook.
IdList	getRootGradebookIds()	Gets the root gradebook Ids in this hierarchy.
GradebookList	getRootGradebooks()	Gets the root gradebooks in this gradebook hierarchy.
boolean	hasChildGradebooks(Id gradebookId)	Tests if a gradebook has any children.
boolean	hasParentGradebooks(Id gradebookId)	Tests if the Gradebook has any parents.
boolean	isAncestorOfGradebook(Id id, Id gradebookId)	Tests if an Id is an ancestor of a gradebook.
boolean	isChildOfGradebook(Id id, Id gradebookId)	Tests if a gradebook is a direct child of another.
boolean	isDescendantOfGradebook(Id id, Id gradebookId)	Tests if an Id is a descendant of a gradebook.
boolean	isParentOfGradebook(Id id, Id gradebookId)	Tests if an Id is a direct parent of a gradebook.
void	useComparativeGradebookView()	The returns from the gradebook methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryGradebookView()	A complete view of the Hierarchy 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

getGradebookHierarchyId

Id getGradebookHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGradebookHierarchy

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

canAccessGradebookHierarchy

boolean canAccessGradebookHierarchy()

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 an application that may not offer hierrachy traversal operations to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeGradebookView

void useComparativeGradebookView()

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

usePlenaryGradebookView

void usePlenaryGradebookView()

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

getRootGradebookIds

IdList getRootGradebookIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root gradebook Ids in this hierarchy.

Returns:

the root gradebook Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootGradebooks

GradebookList getRootGradebooks()
                         throws OperationFailedException,
PermissionDeniedException

Gets the root gradebooks in this gradebook hierarchy.

Returns:

the root gradebooks

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentGradebooks

boolean hasParentGradebooks(Id gradebookId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Gradebook has any parents.

Parameters:

gradebookId - the Id of a gradebook

Returns:

true if the gradebook has parents, false otherwise

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfGradebook

boolean isParentOfGradebook(Id id,
 Id gradebookId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

gradebookId - the Id of a gradebook

Returns:

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

Throws:

NotFoundException - gradebookId is not found

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

getParentGradebookIds

IdList getParentGradebookIds(Id gradebookId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given gradebook.

Parameters:

gradebookId - the Id of a gradebook

Returns:

the parent Ids of the gradebook

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentGradebooks

GradebookList getParentGradebooks(Id gradebookId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given gradebook.

Parameters:

gradebookId - the Id of a gradebook

Returns:

the parents of the gradebook

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfGradebook

boolean isAncestorOfGradebook(Id id,
 Id gradebookId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a gradebook.

Parameters:

id - an Id

gradebookId - the Id of a gradebook

Returns:

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

Throws:

NotFoundException - gradebookId is not found

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

hasChildGradebooks

boolean hasChildGradebooks(Id gradebookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a gradebook has any children.

Parameters:

gradebookId - the Id of a gradebook

Returns:

true if the gradebookId has children, false otherwise

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfGradebook

boolean isChildOfGradebook(Id id,
 Id gradebookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a gradebook is a direct child of another.

Parameters:

id - an Id

gradebookId - the Id of a gradebook

Returns:

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

Throws:

NotFoundException - gradebookId is not found

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

getChildGradebookIds

IdList getChildGradebookIds(Id gradebookId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given gradebook.

Parameters:

gradebookId - the Id to query

Returns:

the children of the gradebook

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildGradebooks

GradebookList getChildGradebooks(Id gradebookId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given gradebook.

Parameters:

gradebookId - the Id to query

Returns:

the children of the gradebook

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfGradebook

boolean isDescendantOfGradebook(Id id,
 Id gradebookId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a gradebook.

Parameters:

id - an Id

gradebookId - the Id of a gradebook

Returns:

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

Throws:

NotFoundException - gradebookId is not found

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

getGradebookNodeIds

Node getGradebookNodeIds(Id gradebookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given gradebook.

Parameters:

gradebookId - 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 gradebook node

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookNodes

GradebookNode getGradebookNodes(Id gradebookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given gradebook.

Parameters:

gradebookId - 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 gradebook node

Throws:

NotFoundException - gradebookId is not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.