Interface CheckSearchSession

All Superinterfaces:

AutoCloseable, CheckQuerySession, Closeable, OsidSession, OsidSession

public interface CheckSearchSession
extends CheckQuerySession

This session provides methods for searching among Check objects. The search query is constructed using the CheckQuery.

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

This session defines views that offer differing behaviors for searching.

• federated engine view: searches include checks in engines of which this engine is an ancestor in the engine hierarchy
• isolated engine view: searches are restricted to checks in this engine

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

Method Summary

Modifier and Type	Method	Description
CheckQuery	getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)	Gets a check query from an inspector.
CheckSearchResults	getChecksBySearch(CheckQuery checkQuery, CheckSearch checkSearch)	Gets the search results matching the given search query using the given search.
CheckSearch	getCheckSearch()	Gets a check search.
CheckSearchOrder	getCheckSearchOrder()	Gets a check search order.

Methods inherited from interface CheckQuerySession

canSearchChecks, getCheckQuery, getChecksByQuery, getEngine, getEngineId, useFederatedEngineView, useIsolatedEngineView

Modifier and Type	Method	Description
boolean	canSearchChecks()	Tests if this user can perform Check lookups.
CheckQuery	getCheckQuery()	Gets a check query.
CheckList	getChecksByQuery(CheckQuery checkQuery)	Gets a list of Checks matching the given check query.
Engine	getEngine()	Gets the Engine associated with this session.
Id	getEngineId()	Gets the Engine Id associated with this session.
void	useFederatedEngineView()	Federates the view for methods in this session.
void	useIsolatedEngineView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

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

getCheckSearch

CheckSearch getCheckSearch()

Gets a check search.

Returns:

the check search

Compliance:

mandatory - This method must be implemented.

getCheckSearchOrder

CheckSearchOrder getCheckSearchOrder()

Gets a check search order. The CheckSearchOrder is supplied to a CheckSearch to specify the ordering of results.

Returns:

the check search order

Compliance:

mandatory - This method must be implemented.

getChecksBySearch

CheckSearchResults getChecksBySearch(CheckQuery checkQuery,
 CheckSearch checkSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

checkQuery - the check query

checkSearch - the check search

Returns:

the check search results

Throws:

NullArgumentException - checkQuery or checkSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - checkQuery or checkSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCheckQueryFromInspector

CheckQuery getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)

Gets a check query from an inspector. The inspector is available from a CheckSearchResults.

Parameters:

checkQueryInspector - a check query inspector

Returns:

the check query

Throws:

NullArgumentException - checkQueryInspector is null

UnsupportedException - checkQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.