org.osid.grading

Interface GradeEntryQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

GradeEntrySearchSession

public interface GradeEntryQuerySession
extends OsidSession

This session provides methods for searching GradeEntry objects. The search query is constructed using the GradeEntryQuery. The grade entry record Type also specifies the record interface for the grade entry query.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchGradeEntries() Tests if this user can perform GradeEntry searches.
Gradebook	getGradebook() Gets the Gradebook associated with this session.
Id	getGradebookId() Gets the Gradebook Id associated with this session.
GradeEntryList	getGradeEntriesByQuery(GradeEntryQuery gradeEntryQuery) Gets a list of entries matching the given grade entry query.
GradeEntryQuery	getGradeEntryQuery() Gets a grade entry 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.

canSearchGradeEntries

boolean canSearchGradeEntries()

Tests if this user can perform GradeEntry 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 grade entries 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.

getGradeEntryQuery

GradeEntryQuery getGradeEntryQuery()

Gets a grade entry query.

Returns:

the grade entry query

Compliance:

mandatory - This method must be implemented.

getGradeEntriesByQuery

GradeEntryList getGradeEntriesByQuery(GradeEntryQuery gradeEntryQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a list of entries matching the given grade entry query.

Parameters:

gradeEntryQuery - the grade entry query

Returns:

the returned GradeEntryList

Throws:

NullArgumentException - gradeEntryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradeEntryQuery is not of this service

Compliance:

mandatory - This method must be implemented.