Interface ChainSearchSession

All Superinterfaces:

AutoCloseable, ChainQuerySession, Closeable, OsidSession, OsidSession

public interface ChainSearchSession
extends ChainQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated antimatroid view: searches include chains in antimatroids of which this antimatroid is an ancestor in the antimatroid hierarchy
• isolated antimatroid view: searches are restricted to chains in this antimatroid

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

Method Summary

Modifier and Type	Method	Description
ChainQuery	getChainQueryFromInspector(ChainQueryInspector chainQueryInspector)	Gets a chain query from an inspector.
ChainSearchResults	getChainsBySearch(ChainQuery chainQuery, ChainSearch chainSearch)	Gets the search results matching the given search query using the given search.
ChainSearch	getChainSearch()	Gets a chain search.
ChainSearchOrder	getChainSearchOrder()	Gets a chain search order.

Methods inherited from interface ChainQuerySession

canSearchChains, getAntimatroid, getAntimatroidId, getChainQuery, getChainsByQuery, useFederatedAntimatroidView, useIsolatedAntimatroidView

Modifier and Type	Method	Description
boolean	canSearchChains()	Tests if this user can perform Chain lookups.
Antimatroid	getAntimatroid()	Gets the Antimatroid associated with this session.
Id	getAntimatroidId()	Gets the Antimatroid Id associated with this session.
ChainQuery	getChainQuery()	Gets a chain query.
ChainList	getChainsByQuery(ChainQuery chainQuery)	Gets a list of Chains matching the given chain query.
void	useFederatedAntimatroidView()	Federates the view for methods in this session.
void	useIsolatedAntimatroidView()	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

getChainSearch

ChainSearch getChainSearch()

Gets a chain search.

Returns:

the chain search

Compliance:

mandatory - This method must be implemented.

getChainSearchOrder

ChainSearchOrder getChainSearchOrder()

Gets a chain search order. The ChainSearchOrder is supplied to a ChainSearch to specify the ordering of results.

Returns:

the chain search order

Compliance:

mandatory - This method must be implemented.

getChainsBySearch

ChainSearchResults getChainsBySearch(ChainQuery chainQuery,
 ChainSearch chainSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

chainQuery - the chain query

chainSearch - the chain search

Returns:

the returned search results

Throws:

NullArgumentException - chainQuery or chainSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - chainQuery or chainSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getChainQueryFromInspector

ChainQuery getChainQueryFromInspector(ChainQueryInspector chainQueryInspector)

Gets a chain query from an inspector. The inspector is available from a ChainSearchResults .

Parameters:

chainQueryInspector - a chain query inspector

Returns:

the chain query

Throws:

NullArgumentException - chainQueryInspector is null

UnsupportedException - chainQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.