Interface GradeSystemGradebookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GradeSystemGradebookSession
extends OsidSession

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

This lookup session defines two 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	canLookupGradeSystemGradebookMappings()	Tests if this user can perform lookups of gradebook/grade system mappings.
IdList	getGradebookIdsByGradeSystem(Id gradeSystemId)	Gets the list of Gradebook Ids mapped to a GradeSystem .
GradebookList	getGradebooksByGradeSystem(Id gradeSystemId)	Gets the list of Gradebooks mapped to a GradeSystem .
IdList	getGradeSystemIdsByGradebook(Id gradebookId)	Gets the list of GradeSystem Ids associated with a Gradebook .
IdList	getGradeSystemIdsByGradebooks(IdList gradebookIds)	Gets the list of GradeSystem Ids corresponding to a list of Gradebooks .
GradeSystemList	getGradeSystemsByGradebook(Id gradebookId)	Gets the list of grade systems associated with a Gradebook .
GradeSystemList	getGradeSystemsByGradebooks(IdList gradebookIds)	Gets the list of grade systems corresponding to a list of Gradebooks .
void	useComparativeGradebookView()	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	usePlenaryGradebookView()	A complete view of the GradebookColumn 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

useComparativeGradebookView

void useComparativeGradebookView()

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.

usePlenaryGradebookView

void usePlenaryGradebookView()

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

canLookupGradeSystemGradebookMappings

boolean canLookupGradeSystemGradebookMappings()

Tests if this user can perform lookups of gradebook/grade system 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 . This 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.

getGradeSystemIdsByGradebook

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

Gets the list of GradeSystem Ids associated with a Gradebook .

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related grade system 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.

getGradeSystemsByGradebook

GradeSystemList getGradeSystemsByGradebook(Id gradebookId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of grade systems associated with a Gradebook .

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related grade systems

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.

getGradeSystemIdsByGradebooks

IdList getGradeSystemIdsByGradebooks(IdList gradebookIds)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of grade system Ids

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradeSystemsByGradebooks

GradeSystemList getGradeSystemsByGradebooks(IdList gradebookIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of grade systems corresponding to a list of Gradebooks .

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of grade systems

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookIdsByGradeSystem

IdList getGradebookIdsByGradeSystem(Id gradeSystemId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Gradebook Ids mapped to a GradeSystem .

Parameters:

gradeSystemId - Id of a GradeSystem

Returns:

list of gradebook Ids

Throws:

NotFoundException - gradeSystemId is not found

NullArgumentException - gradeSystemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebooksByGradeSystem

GradebookList getGradebooksByGradeSystem(Id gradeSystemId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Gradebooks mapped to a GradeSystem .

Parameters:

gradeSystemId - Id of a GradeSystem

Returns:

list of gradebooks

Throws:

NotFoundException - gradeSystemId is not found

NullArgumentException - gradeSystemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.