org.osid.grading

Interface GradeSystemSmartGradebookSession

All Superinterfaces:

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

public interface GradeSystemSmartGradebookSession
extends OsidSession

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

This Gradebook has a default query that matches any grade system and a default search order that specifies no sequencing. The queries may be examined using a GradeSystemQueryInspector. The query may be modified by converting the inspector back to a GradeSystemQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyGradeSystemQuery(GradeSystemQuery gradeSystemQuery) Applies a grade system query to this gradebook.
void	applyGradeSystemSequencing(GradeSystemSearchOrder gradeSystemSearchOrder) Applies a grade system search order to this gradebook.
boolean	canManageSmartGradebooks() Tests if this user can manage smart gradebooks.
Gradebook	getGradebook() Gets the Gradebook associated with this session.
Id	getGradebookId() Gets the Gradebook Id associated with this session.
GradeSystemQuery	getGradeSystemQuery() Gets a grade system query.
GradeSystemQuery	getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector) Gets a grade system query from an inspector.
GradeSystemSearchOrder	getGradeSystemSearchOrder() Gets a grade system search order.
GradeSystemQueryInspector	inspectGradeSystemQuery() Gets a grade system 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.

getGradeSystemQuery

GradeSystemQuery getGradeSystemQuery()

Gets a grade system query.

Returns:

the grade system query

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchOrder

GradeSystemSearchOrder getGradeSystemSearchOrder()

Gets a grade system search order.

Returns:

the grade system search order

Compliance:

mandatory - This method must be implemented.

applyGradeSystemQuery

void applyGradeSystemQuery(GradeSystemQuery gradeSystemQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a grade system query to this gradebook.

Parameters:

gradeSystemQuery - the grade system query

Throws:

NullArgumentException - gradeSystemQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - gradeSystemQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectGradeSystemQuery

GradeSystemQueryInspector inspectGradeSystemQuery()
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets a grade system query inspector for this gradebook.

Returns:

the grade system query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyGradeSystemSequencing

void applyGradeSystemSequencing(GradeSystemSearchOrder gradeSystemSearchOrder)
                                throws OperationFailedException,
                                       PermissionDeniedException

Applies a grade system search order to this gradebook.

Parameters:

gradeSystemSearchOrder - the grade system search order

Throws:

NullArgumentException - gradeSystemSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - gradeSystemSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getGradeSystemQueryFromInspector

GradeSystemQuery getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector)

Gets a grade system query from an inspector.

Parameters:

gradeSystemQueryInspector - a grade system query inspector

Returns:

the grade system query

Throws:

NullArgumentException - gradeSystemQueryInspector is null

UnsupportedException - gradeSystemQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.