Interface GradeSearchSession

All Superinterfaces:

AutoCloseable, Closeable, GradeQuerySession, OsidSession, OsidSession

public interface GradeSearchSession
extends GradeQuerySession

This session provides methods for searching among Grades . The search query is constructed using the GradeQuery .

getGradesByQuery() is the basic search method and returns a list of Grades . A more advanced search may be performed with getGradesBySearch() . It accepts a GradeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getGradesBySearch() returns a GradeSearchResults that can be used to access the resulting GradeList or be used to perform a search within the result set through Gra deSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
GradeQuery	getGradeQueryFromInspector(GradeQueryInspector gradeQueryInspector)	Gets a grade query from an inspector.
GradeSearchResults	getGradesBySearch(GradeQuery gradeQuery, GradeSearch gradeSearch)	Gets the search results matching the given search query using the given search.
GradeSearch	getGradeSearch()	Gets a grade search.
GradeSearchOrder	getGradeSearchOrder()	Gets a grade search order.

Methods inherited from interface Closeable

close

Methods inherited from interface GradeQuerySession

canSearchGrades, getGradebook, getGradebookId, getGradeQuery, getGradesByQuery, useFederatedGradebookView, useIsolatedGradebookView

Modifier and Type	Method	Description
boolean	canSearchGrades()	Tests if this user can perform Grade lookups.
Gradebook	getGradebook()	Gets the Gradebook associated with this session.
Id	getGradebookId()	Gets the Gradebook Id associated with this session.
GradeQuery	getGradeQuery()	Gets a grade query.
GradeList	getGradesByQuery(GradeQuery gradeQuery)	Gets a list of Grades matching the given search.
void	useFederatedGradebookView()	Federates the view for methods in this session.
void	useIsolatedGradebookView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getGradeSearch

GradeSearch getGradeSearch()

Gets a grade search.

Returns:

the grade search

Compliance:

mandatory - This method must be implemented.

getGradeSearchOrder

GradeSearchOrder getGradeSearchOrder()

Gets a grade search order. The GradeSearchOrder is supplied to a GradeSearch to specify the ordering of results.

Returns:

the grade search order

Compliance:

mandatory - This method must be implemented.

getGradesBySearch

GradeSearchResults getGradesBySearch(GradeQuery gradeQuery,
 GradeSearch gradeSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

gradeQuery - the grade query

gradeSearch - the grade search

Returns:

the returned search results

Throws:

NullArgumentException - gradeQuery or gradeSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradeQuery or gradeSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getGradeQueryFromInspector

GradeQuery getGradeQueryFromInspector(GradeQueryInspector gradeQueryInspector)

Gets a grade query from an inspector. The inspector is available from a GradeSearchResults .

Parameters:

gradeQueryInspector - a grade query inspector

Returns:

the grade query

Throws:

NullArgumentException - gradeQueryInspector is null

UnsupportedException - gradeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.