Interface GradebookSearchSession

All Superinterfaces:

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

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

close

Methods inherited from interface GradebookQuerySession

canSearchGradebooks, getGradebookQuery, getGradebooksByQuery

Modifier and Type	Method	Description
boolean	canSearchGradebooks()	Tests if this user can perform Gradebook searches.
GradebookQuery	getGradebookQuery()	Gets a gradebook query.
GradebookList	getGradebooksByQuery(GradebookQuery gradebookQuery)	Gets a list of Gradebook objects matching the given gradebook query.

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

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.