Interface GradeGradebookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GradeGradebookSession
extends OsidSession

This session provides methods to retrieve Grade to Gradebook mappings. A Grade may appear in multiple Gradebook objects . Each gradebook may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupGradeGradebookMappings()	Tests if this user can perform lookups of grade/gradebook mappings.
IdList	getGradebookIdsByGrade(Id gradeId)	Gets the Gradebook Ids mapped to a Grade .
GradebookList	getGradebooksByGrade(Id gradeId)	Gets the Gradebooks mapped to a Grade .
IdList	getGradeIdsByGradebook(Id gradebookId)	Gets the list of Grade Ids associated with a Gradebook .
IdList	getGradeIdsByGradebooks(IdList gradebookIds)	Gets the list of Grade Ids corresponding to a list of Gradebooks .
GradeList	getGradesByGradebook(Id gradebookId)	Gets the list of Grades associated with a Gradebook .
GradeList	getGradesByGradebooks(IdList gradebookIds)	Gets the list of Grade corresponding to a list of Gradebooks .
void	useComparativeGradeGradebookView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryGradeGradebookView()	A complete view of the Grade and Gradebook 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

canLookupGradeGradebookMappings

boolean canLookupGradeGradebookMappings()

Tests if this user can perform lookups of grade/gradebook mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeGradeGradebookView

void useComparativeGradeGradebookView()

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

usePlenaryGradeGradebookView

void usePlenaryGradeGradebookView()

A complete view of the Grade and Gradebook 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.

getGradeIdsByGradebook

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

Gets the list of Grade Ids associated with a Gradebook .

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related grade Ids

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.

getGradesByGradebook

GradeList getGradesByGradebook(Id gradebookId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Grades associated with a Gradebook .

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related grades

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.

getGradeIdsByGradebooks

IdList getGradeIdsByGradebooks(IdList gradebookIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Grade Ids corresponding to a list of Gradebooks .

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of grade Ids

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradesByGradebooks

GradeList getGradesByGradebooks(IdList gradebookIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Grade corresponding to a list of Gradebooks .

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of grades

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookIdsByGrade

IdList getGradebookIdsByGrade(Id gradeId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Gradebook Ids mapped to a Grade .

Parameters:

gradeId - Id of a Grade

Returns:

list of gradebook Ids

Throws:

NotFoundException - gradeId is not found

NullArgumentException - gradeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebooksByGrade

GradebookList getGradebooksByGrade(Id gradeId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Gradebooks mapped to a Grade .

Parameters:

gradeId - Id of a Grade

Returns:

list of gradebooks

Throws:

NotFoundException - gradeId is not found

NullArgumentException - gradeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.