org.osid.sequencing

Interface ChainSearchSession

All Superinterfaces:

java.lang.AutoCloseable, ChainQuerySession, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.sequencing.ChainQuerySession

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

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.