Interface GradeEntryGradebookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GradeEntryGradebookSession
extends OsidSession

This session provides methods to retrieve GradeEntry to Gradebook mappings. A GradeEntry 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	canLookupGradeEntryGradebookMappings()	Tests if this user can perform lookups of gradebook/grade entry mappings.
IdList	getGradebookIdsByGradeEntry(Id gradeEntryId)	Gets the list of Gradebook Ids mapped to a GradeEntry .
GradebookList	getGradebooksByGradeEntry(Id gradeEntryId)	Gets the list of Gradebooks mapped to a GradeEntry .
GradeEntryList	getGradeEntriesByGradebook(Id gradebookId)	Gets the list of grade entries associated with a Gradebook .
GradeEntryList	getGradeEntriesByGradebooks(IdList gradebookIds)	Gets the list of grade entries corresponding to a list of Gradebooks .
IdList	getGradeEntryIdsByGradebook(Id gradebookId)	Gets the list of GradeEntry Ids associated with a Gradebook .
IdList	getGradeEntryIdsByGradebooks(IdList gradebookIds)	Gets the list of GradeEntry Ids 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.

canLookupGradeEntryGradebookMappings

boolean canLookupGradeEntryGradebookMappings()

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

getGradeEntryIdsByGradebook

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

Gets the list of GradeEntry Ids associated with a Gradebook .

Parameters:

gradebookId - Id of the Gradebook

Returns:

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

getGradeEntriesByGradebook

GradeEntryList getGradeEntriesByGradebook(Id gradebookId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of grade entries associated with a Gradebook .

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related grade entries

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.

getGradeEntryIdsByGradebooks

IdList getGradeEntryIdsByGradebooks(IdList gradebookIds)
                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of grade entry Ids

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradeEntriesByGradebooks

GradeEntryList getGradeEntriesByGradebooks(IdList gradebookIds)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of grade entries

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookIdsByGradeEntry

IdList getGradebookIdsByGradeEntry(Id gradeEntryId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Gradebook Ids mapped to a GradeEntry .

Parameters:

gradeEntryId - Id of a GradeEntry

Returns:

list of gradebook Ids

Throws:

NotFoundException - gradeEntryId is not found

NullArgumentException - gradeEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebooksByGradeEntry

GradebookList getGradebooksByGradeEntry(Id gradeEntryId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Gradebooks mapped to a GradeEntry .

Parameters:

gradeEntryId - Id of a GradeEntry

Returns:

list of gradebooks

Throws:

NotFoundException - gradeEntryId is not found

NullArgumentException - gradeEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.