Interface GradeEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, GradeEntryQuerySession, OsidSession, OsidSession

public interface GradeEntrySearchSession
extends GradeEntryQuerySession

This session provides methods for searching GradeEntry objects. The search query is constructed using the GradeEntryQuery .

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

This session defines views that offer differing behaviors for searching.

• federated gradebook view: searches include grade entries in gradebooks of which this gradebook is an 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

Modifier and Type	Method	Description
GradeEntrySearchResults	getGradeEntriesBySearch(GradeEntryQuery gradeEntryQuery, GradeEntrySearch gradeEntrySearch)	Gets the search results matching the given search query using the given search.
GradeEntryQuery	getGradeEntryQueryFromInspector(GradeEntryQueryInspector gradeEntryQueryInspector)	Gets a grade entry query from an inspector.
GradeEntrySearch	getGradeEntrySearch()	Gets a grade entry search.
GradeEntrySearchOrder	getGradeEntrySearchOrder()	Gets a grade entry search order.

Methods inherited from interface Closeable

close

Methods inherited from interface GradeEntryQuerySession

canSearchGradeEntries, getGradebook, getGradebookId, getGradeEntriesByQuery, getGradeEntryQuery, useFederatedGradebookView, useIsolatedGradebookView

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

getGradeEntrySearch

GradeEntrySearch getGradeEntrySearch()

Gets a grade entry search.

Returns:

the grade entry search

Compliance:

mandatory - This method must be implemented.

getGradeEntrySearchOrder

GradeEntrySearchOrder getGradeEntrySearchOrder()

Gets a grade entry search order. The GradeEntrySearchOrder is supplied to a GradeEntrySearch to specify the ordering of results.

Returns:

the grade entry search order

Compliance:

mandatory - This method must be implemented.

getGradeEntriesBySearch

GradeEntrySearchResults getGradeEntriesBySearch(GradeEntryQuery gradeEntryQuery,
 GradeEntrySearch gradeEntrySearch)
                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

gradeEntryQuery - the grade entry query

gradeEntrySearch - the grade entry search

Returns:

the grade entry search results

Throws:

NullArgumentException - gradeEntryQuery or gradeEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradeEntrySearch or gradeEntryQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getGradeEntryQueryFromInspector

GradeEntryQuery getGradeEntryQueryFromInspector(GradeEntryQueryInspector gradeEntryQueryInspector)

Gets a grade entry query from an inspector. The inspector is available from an GradeEntrySearchResults .

Parameters:

gradeEntryQueryInspector - a grade entry query inspector

Returns:

the grade entry query

Throws:

NullArgumentException - gradeEntryQueryInspector is null

UnsupportedException - gradeEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.