org.osid.grading

Interface GradeSystemSearchSession

All Superinterfaces:

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

public interface GradeSystemSearchSession
extends GradeSystemQuerySession

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

getGradeSystemsByQuery() is the basic search method and returns a list of GradeSystems. A more advanced search may be performed with getGradeSystemsBySearch(). It accepts a GradeSystemSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getGradeSystemsBySearch() returns a GradeSystemSearchResults that can be used to access the resulting GradeSystemList or be used to perform a search within the result set through GradeSystemSearch.

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
GradeSystemQuery	getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector) Gets a grade system query from an inspector.
GradeSystemSearchResults	getGradeSystemsBySearch(GradeSystemQuery gradeSystemQuery, GradeSystemSearch gradeSystemSearch) Gets the search results matching the given search query using the given search.
GradeSystemSearch	getGradeSystemSearch() Gets a grade system search.
GradeSystemSearchOrder	getGradeSystemSearchOrder() Gets a grade system search order.

Methods inherited from interface org.osid.grading.GradeSystemQuerySession

canSearchGradeSystems, getGradebook, getGradebookId, getGradeSystemQuery, getGradeSystemsByQuery, useFederatedGradebookView, useIsolatedGradebookView

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

getGradeSystemSearch

GradeSystemSearch getGradeSystemSearch()

Gets a grade system search.

Returns:

a grade system search

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchOrder

GradeSystemSearchOrder getGradeSystemSearchOrder()

Gets a grade system search order. The GradeSystemSearchOrder is supplied to a GradeSystemSearch to specify the ordering of results.

Returns:

the grade system search order

Compliance:

mandatory - This method must be implemented.

getGradeSystemsBySearch

GradeSystemSearchResults getGradeSystemsBySearch(GradeSystemQuery gradeSystemQuery,
                                               GradeSystemSearch gradeSystemSearch)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

gradeSystemQuery - the grade system query

gradeSystemSearch - the grade system search

Returns:

the grade system search results

Throws:

NullArgumentException - gradeSystemQuery or gradeSystemSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradeSystemQuery or gradeSystemSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getGradeSystemQueryFromInspector

GradeSystemQuery getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector)

Gets a grade system query from an inspector. The inspector is available from an GradeSystemSearchResults.

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.