Interface KeySearchSession

All Superinterfaces:

AutoCloseable, Closeable, KeyQuerySession, OsidSession, OsidSession

public interface KeySearchSession
extends KeyQuerySession

This session provides methods for searching Keys. The search query is constructed using the KeyQuery. The key record Type also specifies the record for the key query.

getKeysByQuery() is the basic search method and returns a list of Keys. A more advanced search may be performed with getKeysBySearch(). It accepts an KeySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getKeysBySearch() returns a KeySearchResult that can be used to access the resulting KeyList or be used to perform a search within the result set through KeySearch.

This session defines views that offer differing behaviors for searching.

• federated agency view: searches include keys in agencies of which this agency is a ancestor in the agency hierarchy
• isolated agency view: searches are restricted to agents in this agency

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

Method Summary

Modifier and Type	Method	Description
KeyQuery	getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)	Gets a key query from an inspector.
KeySearchResults	getKeysBySearch(KeyQuery keyQuery, KeySearch keySearch)	Gets a list of Keys matching the given search.
KeySearch	getKeySearch()	Gets a key query.
KeySearchOrder	getKeySearchOrder()	Gets a key search order.

Methods inherited from interface Closeable

close

Methods inherited from interface KeyQuerySession

canSearchKeys, getAgency, getAgencyId, getKeyQuery, getKeysByQuery, useFederatedAgencyView, useIsolatedAgencyView

Modifier and Type	Method	Description
boolean	canSearchKeys()	Tests if this user can perform Key searches.
Agency	getAgency()	Gets the Agency associated with this session.
Id	getAgencyId()	Gets the Agency Id associated with this session.
KeyQuery	getKeyQuery()	Gets a key query.
KeyList	getKeysByQuery(KeyQuery keyQuery)	Gets a list of Keys matching the given search.
void	useFederatedAgencyView()	Federates the view for methods in this session.
void	useIsolatedAgencyView()	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

getKeySearch

KeySearch getKeySearch()

Gets a key query.

Returns:

the key search

Compliance:

mandatory - This method must be implemented.

getKeySearchOrder

KeySearchOrder getKeySearchOrder()

Gets a key search order. The KeySearchOrder is supplied to a KeySearch to specify the ordering of results.

Returns:

the key search order

Compliance:

mandatory - This method must be implemented.

getKeysBySearch

KeySearchResults getKeysBySearch(KeyQuery keyQuery,
 KeySearch keySearch)
                          throws OperationFailedException,
PermissionDeniedException

Gets a list of Keys matching the given search.

Parameters:

keyQuery - the key query

keySearch - the key search

Returns:

the returned search results

Throws:

NullArgumentException - keyQuery or keySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - keySearch or a keyQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getKeyQueryFromInspector

KeyQuery getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)

Gets a key query from an inspector. The inspector is available from an KeySearchResults.

Parameters:

keyQueryInspector - a query inspector

Returns:

the key query

Throws:

NullArgumentException - keyQueryInspector is null

UnsupportedException - keyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.