org.osid.grading

Interface GradebookColumnLookupSession

All Superinterfaces:

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

public interface GradebookColumnLookupSession
extends OsidSession

This session provides methods for retrieving GradebookColumns .

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated gradebook view: All gradebook column methods in this session operate, retrieve and pertain to gradebook columns defined explicitly in the current gradebook. Using an isolated view is useful for managing gradebook columns with the GradebookColumnAdminSession.
• federated gradebook view: All gradebook column methods in this session operate, retrieve and pertain to all gradebook columns defined in this gradebook and any other gradebooks implicitly available in this gradebook through gradebook inheritence.

Gradebook columns may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the GradebookColumn.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupGradebookColumns() Tests if this user can perform GradebookColumn lookups.
Gradebook	getGradebook() Gets the Gradebook associated with this session.
GradebookColumn	getGradebookColumn(Id gradebookColumnId) Gets the GradebookColumn specified by its Id.
GradebookColumnList	getGradebookColumns() Gets all gradebook columns.
GradebookColumnList	getGradebookColumnsByGenusType(Type gradebookColumnGenusType) Gets a GradebookColumnList corresponding to the given gradebook column genus Type which does not include gradebook columns of genus types derived from the specified Type.
GradebookColumnList	getGradebookColumnsByIds(IdList gradebookColumnIds) Gets a GradebookColumnList corresponding to the given IdList.
GradebookColumnList	getGradebookColumnsByParentGenusType(Type gradebookColumnGenusType) Gets a GradebookColumnList corresponding to the given gradebook column genus Type and include any additional columns with genus types derived from the specified Type.
GradebookColumnList	getGradebookColumnsByRecordType(Type gradebookColumnRecordType) Gets a GradebookColumnList containing the given gradebook column record Type.
GradebookColumnSummary	getGradebookColumnSummary(Id gradebookColumnId) Gets the GradebookColumnSummary for summary results.
Id	getGradebookId() Gets the Gradebook Id associated with this session.
boolean	supportsSummary() Tests if a summary entry is available.
void	useComparativeGradebookColumnView() 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	useFederatedGradebookView() Federates the view for methods in this session.
void	useIsolatedGradebookView() Isolates the view for methods in this session.
void	usePlenaryGradebookColumnView() A complete view of the GradebookColumn 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

getGradebookId

Id getGradebookId()

Gets the Gradebook Id associated with this session.

Returns:

the Gradebook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGradebook

Gradebook getGradebook()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Gradebook associated with this session.

Returns:

the Gradebook associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupGradebookColumns

boolean canLookupGradebookColumns()

Tests if this user can perform GradebookColumn lookups. 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 application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeGradebookColumnView

void useComparativeGradebookColumnView()

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.

usePlenaryGradebookColumnView

void usePlenaryGradebookColumnView()

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

useFederatedGradebookView

void useFederatedGradebookView()

Federates the view for methods in this session. A federated view will include gradebook columns in gradebooks which are children of this gradebook in the gradebook hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedGradebookView

void useIsolatedGradebookView()

Isolates the view for methods in this session. An isolated view restricts lookups to this gradebook only.

Compliance:

mandatory - This method is must be implemented.

getGradebookColumn

GradebookColumn getGradebookColumn(Id gradebookColumnId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the GradebookColumn specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned GradebookColumn may have a different Id than requested, such as the case where a duplicate Id was assigned to a GradebookColumn and retained for compatibility.

Parameters:

gradebookColumnId - Id of the GradebookColumn

Returns:

the gradebook column

Throws:

NotFoundException - gradebookColumnId not found

NullArgumentException - gradebookColumnId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getGradebookColumnsByIds

GradebookColumnList getGradebookColumnsByIds(IdList gradebookColumnIds)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets a GradebookColumnList corresponding to the given IdList. In plenary mode, the returned list contains all of the gradebook columns specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible gradeboook columns may be omitted from the list.

Parameters:

gradebookColumnIds - the list of Ids to retrieve

Returns:

the returned GradebookColumn list

Throws:

NotFoundException - an Id was not found

NullArgumentException - gradeBookColumnIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookColumnsByGenusType

GradebookColumnList getGradebookColumnsByGenusType(Type gradebookColumnGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets a GradebookColumnList corresponding to the given gradebook column genus Type which does not include gradebook columns of genus types derived from the specified Type. In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.

Parameters:

gradebookColumnGenusType - a gradebook column genus type

Returns:

the returned GradebookColumn list

Throws:

NullArgumentException - gradebookColumnGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookColumnsByParentGenusType

GradebookColumnList getGradebookColumnsByParentGenusType(Type gradebookColumnGenusType)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets a GradebookColumnList corresponding to the given gradebook column genus Type and include any additional columns with genus types derived from the specified Type. In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.

Parameters:

gradebookColumnGenusType - a gradebook column genus type

Returns:

the returned GradebookColumn list

Throws:

NullArgumentException - gradebookColumnGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookColumnsByRecordType

GradebookColumnList getGradebookColumnsByRecordType(Type gradebookColumnRecordType)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a GradebookColumnList containing the given gradebook column record Type. In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.

Parameters:

gradebookColumnRecordType - a gradebook column record type

Returns:

the returned GradebookColumn list

Throws:

NullArgumentException - gradebookColumnRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGradebookColumns

GradebookColumnList getGradebookColumns()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets all gradebook columns. In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.

Returns:

a GradebookColumn

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

supportsSummary

boolean supportsSummary()

Tests if a summary entry is available.

Returns:

true if a summary entry is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSummary

GradebookColumnSummary getGradebookColumnSummary(Id gradebookColumnId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Gets the GradebookColumnSummary for summary results.

Parameters:

gradebookColumnId - Id of the GradebookColumn

Returns:

the gradebook column summary

Throws:

NotFoundException - gradebookColumnId is not found

NullArgumentException - gradebookColumnId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnimplementedException - hasSummary() is false

Compliance:

mandatory - This method is must be implemented.