org.osid.grading

Interface GradeSystemQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

GradeSystemSearchSession

public interface GradeSystemQuerySession
extends OsidSession

This session provides methods for searching among GradeSystems. The search query is constructed using the GradeSystemQuery.

This session defines views that offer differing behaviors for searching.

• federated gradebook view: searches include grade systems in gradebooks of which this gradebook is a ancestor in the gradebook hierarchy
• isolated gradebook view: searches are restricted to grade systems in this gradebook

Grade systems may have a query record indicated by their respective record types. The query record is accessed via the GradeSystemQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchGradeSystems() Tests if this user can perform GradeSystem searches.
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.
GradeSystemList	getGradeSystemsByQuery(GradeSystemQuery gradeSystemQuery) Gets a list of GradeSystem objects matching the given grade system query.
void	useFederatedGradebookView() Federates the view for methods in this session.
void	useIsolatedGradebookView() Isolates the view for methods in this session.

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.

canSearchGradeSystems

boolean canSearchGradeSystems()

Tests if this user can perform GradeSystem searches. 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 search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedGradebookView

void useFederatedGradebookView()

Federates the view for methods in this session. A federated view will include grades 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 searches to this gradebook only.

Compliance:

mandatory - This method is must be implemented.

getGradeSystemQuery

GradeSystemQuery getGradeSystemQuery()

Gets a grade system query.

Returns:

a grade system query

Compliance:

mandatory - This method must be implemented.

getGradeSystemsByQuery

GradeSystemList getGradeSystemsByQuery(GradeSystemQuery gradeSystemQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of GradeSystem objects matching the given grade system query.

Parameters:

gradeSystemQuery - the grade system query

Returns:

the returned GradeSystemList

Throws:

NullArgumentException - gradeSystemQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradeSystemQuery is not of this service

Compliance:

mandatory - This method must be implemented.