Interface GradeSystemSearchSession

All Superinterfaces:

AutoCloseable, Closeable, GradeSystemQuerySession, OsidSession, 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 anncestor 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface GradeSystemQuerySession

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

Modifier and Type	Method	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 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

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.