org.osid.grading

Interface GradebookColumnGradebookSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface GradebookColumnGradebookSession
extends OsidSession

This session provides methods to retrieve GradebookColumn to Gradebook mappings. A GradebookColumn 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

Methods

Modifier and Type	Method and Description
boolean	canLookupGradebookColumnGradebookMappings() Tests if this user can perform lookups of gradebook/column mappings.
IdList	getGradebookColumnIdsByGradebook(Id gradebookId) Gets the list of GradebookColumn Ids associated with a Gradebook.
IdList	getGradebookColumnIdsByGradebooks(IdList gradebookIds) Gets the list of GradebookColumn Ids corresponding to a list of Gradebooks.
GradebookColumnList	getGradebookColumnsByGradebook(Id gradebookId) Gets the list of gradebook columns associated with a Gradebook.
GradebookColumnList	getGradebookColumnsByGradebooks(IdList gradebookIds) Gets the list of gradebook columns corresponding to a list of Gradebooks.
IdList	getGradebookIdsByGradebookColumn(Id gradebookColumnId) Gets the list of Gradebook Ids mapped to a GradebookColumn.
GradebookList	getGradebooksByGradebookColumn(Id gradebookColumnId) Gets the list of Gradebooks mapped to a GradebookColumn.
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 org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canLookupGradebookColumnGradebookMappings

boolean canLookupGradebookColumnGradebookMappings()

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

getGradebookColumnIdsByGradebook

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

Gets the list of GradebookColumn Ids associated with a Gradebook.

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related gradebook column 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.

getGradebookColumnsByGradebook

GradebookColumnList getGradebookColumnsByGradebook(Id gradebookId)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Gets the list of gradebook columns associated with a Gradebook.

Parameters:

gradebookId - Id of the Gradebook

Returns:

list of related gradebook columns

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.

getGradebookColumnIdsByGradebooks

IdList getGradebookColumnIdsByGradebooks(IdList gradebookIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of gradebook column Ids

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookColumnsByGradebooks

GradebookColumnList getGradebookColumnsByGradebooks(IdList gradebookIds)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the list of gradebook columns corresponding to a list of Gradebooks.

Parameters:

gradebookIds - list of gradebook Ids

Returns:

list of gradebook columns

Throws:

NullArgumentException - gradebookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookIdsByGradebookColumn

IdList getGradebookIdsByGradebookColumn(Id gradebookColumnId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the list of Gradebook Ids mapped to a GradebookColumn.

Parameters:

gradebookColumnId - Id of a GradebookColumn

Returns:

list of gradebook Ids

Throws:

NotFoundException - gradebookColumnId is not found

NullArgumentException - gradebookColumnId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebooksByGradebookColumn

GradebookList getGradebooksByGradebookColumn(Id gradebookColumnId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the list of Gradebooks mapped to a GradebookColumn.

Parameters:

gradebookColumnId - Id of a GradebookColumn

Returns:

list of gradebooks

Throws:

NotFoundException - gradebookColumnId is not found

NullArgumentException - gradebookColumnId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.