org.osid.grading

Interface GradebookColumnSmartGradebookSession

All Superinterfaces:

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

public interface GradebookColumnSmartGradebookSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A GradebookColumnQuery can be retrieved from this session and mapped to this Gradebook to create a virtual collection of GradebookColumns. The entries may be sequenced using the GradebookColumnSearchOrder from this session.

This Gradebook has a default query that matches any gradebook column and a default search order that specifies no sequencing. The queries may be examined using a GradebookColumnQueryInspector. The query may be modified by converting the inspector back to a GradebookColumnQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyGradebookColumnQuery(GradebookColumnQuery gradebookColumnQuery) Applies a gradebook column query to this gradebook.
void	applyGradebookColumnSequencing(GradebookColumnSearchOrder gradebookColumnSearchOrder) Applies a gradebook column search order to this gradebook.
boolean	canManageSmartGradebooks() Tests if this user can manage smart gradebooks.
Gradebook	getGradebook() Gets the Gradebook associated with this session.
GradebookColumnQuery	getGradebookColumnQuery() Gets a gradebook column query.
GradebookColumnQuery	getGradebookColumnQueryFromInspector(GradebookColumnQuery gradebookColumnQueryInspector) Gets a gradebook column query from an inspector.
GradebookColumnSearchOrder	getGradebookColumnSearchOrder() Gets a gradebook column search order.
Id	getGradebookId() Gets the Gradebook Id associated with this session.
GradebookColumnQueryInspector	inspectGradebookColumnQuery() Gets a gradebook column query inspector for this gradebook.

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.

canManageSmartGradebooks

boolean canManageSmartGradebooks()

Tests if this user can manage smart gradebooks. 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 smart operations.

Returns:

false if smart gradebook methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getGradebookColumnQuery

GradebookColumnQuery getGradebookColumnQuery()

Gets a gradebook column query.

Returns:

the gradebook column query

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSearchOrder

GradebookColumnSearchOrder getGradebookColumnSearchOrder()

Gets a gradebook column search order.

Returns:

the gradebook column search order

Compliance:

mandatory - This method must be implemented.

applyGradebookColumnQuery

void applyGradebookColumnQuery(GradebookColumnQuery gradebookColumnQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a gradebook column query to this gradebook.

Parameters:

gradebookColumnQuery - the gradebook column query

Throws:

NullArgumentException - gradebookColumnQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - gradebookColumnQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectGradebookColumnQuery

GradebookColumnQueryInspector inspectGradebookColumnQuery()
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a gradebook column query inspector for this gradebook.

Returns:

the gradebook column query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyGradebookColumnSequencing

void applyGradebookColumnSequencing(GradebookColumnSearchOrder gradebookColumnSearchOrder)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a gradebook column search order to this gradebook.

Parameters:

gradebookColumnSearchOrder - the gradebook column search order

Throws:

NullArgumentException - gradebookColumnSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - gradebookColumnSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getGradebookColumnQueryFromInspector

GradebookColumnQuery getGradebookColumnQueryFromInspector(GradebookColumnQuery gradebookColumnQueryInspector)

Gets a gradebook column query from an inspector.

Parameters:

gradebookColumnQueryInspector - a gradebook column query inspector

Returns:

the gradebook column query

Throws:

NullArgumentException - gradebookColumnQueryInspector is null

UnsupportedException - gradebookColumnQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.