org.osid.grading

Interface GradebookSearchSession

All Superinterfaces:

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

public interface GradebookSearchSession
extends GradebookQuerySession

This session provides methods for searching among Gradebook objects. The search query is constructed using the GradebookQuery.

getGradebooksByQuery() is the basic search method and returns a list of Gradebook objects.A more advanced search may be performed with getGradebooksBySearch(). It accepts a GradebookSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getGradebooksBySearch() returns a GradebookSearchResults that can be used to access the resulting GradebookList or be used to perform a search within the result set through GradebookSearch.

Gradebooks may have a query record indicated by their respective record types. The query record is accessed via the GradebookQuery.

Method Summary

Methods

Modifier and Type	Method and Description
GradebookQuery	getGradebookQueryFromInspector(GradebookQueryInspector gradebookQueryInspector) Gets a gradebook query from an inspector.
GradebookSearchResults	getGradebooksBySearch(GradebookQuery gradebookQuery, GradebookSearch gradebookSearch) Gets the search results matching the given search query using the given search.
GradebookSearch	getGradebookSearch() Gets a gradebook search.
GradebookSearchOrder	getGradebookSearchOrder() Gets a gradebook search order.

Methods inherited from interface org.osid.grading.GradebookQuerySession

canSearchGradebooks, getGradebookQuery, getGradebooksByQuery

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

getGradebookSearch

GradebookSearch getGradebookSearch()

Gets a gradebook search.

Returns:

a gradebook search

Compliance:

mandatory - This method must be implemented.

getGradebookSearchOrder

GradebookSearchOrder getGradebookSearchOrder()

Gets a gradebook search order. The GradebookSearchOrder is supplied to a GradebookSearch to specify the ordering of results.

Returns:

the gradebook search order

Compliance:

mandatory - This method must be implemented.

getGradebooksBySearch

GradebookSearchResults getGradebooksBySearch(GradebookQuery gradebookQuery,
                                           GradebookSearch gradebookSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

gradebookQuery - the gradebook query

gradebookSearch - the gradebook search

Returns:

the gradebook search results

Throws:

NullArgumentException - gradebookQuery or gradebookSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradebookQuery or gradebookSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getGradebookQueryFromInspector

GradebookQuery getGradebookQueryFromInspector(GradebookQueryInspector gradebookQueryInspector)

Gets a gradebook query from an inspector. The inspector is available from an GradenookSearchResults.

Parameters:

gradebookQueryInspector - a gradebook query inspector

Returns:

the gradebook query

Throws:

NullArgumentException - gradebookQueryInspector is null

UnsupportedException - gradebookQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.