org.osid.offering

Interface ResultSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ResultQuerySession

public interface ResultSearchSession
extends ResultQuerySession

This session provides methods for searching Result objects. The search query is constructed using the ResultQuery. The result record Type also specifies the record for the result query.

getResultsByQuery() is the basic search method and returns a list of Result elements. A more advanced search may be performed with getResultsBySearch(). It accepts an ResultSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getResultsBySearch() returns an ResultSearchResults that can be used to access the resulting ResultList or be used to perform a search within the result set through ResultSearch.

This session defines views that offer differing behaviors for searching.

• federated catalogue view: searches include results in catalogues of which this catalogue is a ancestor in the catalogue hierarchy
• isolated catalogue view: searches are restricted to results in this catalogue

Results may have a query record indicated by their respective record types. The query record is accessed via the ResultQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
ResultQuery	getResultQueryFromInspector(ResultQueryInspector resultQueryInspector) Gets an result query from an inspector.
ResultSearchResults	getResultsBySearch(ResultQuery resultQuery, ResultSearch resultSearch) Gets the search results matching the given search.
ResultSearch	getResultSearch() Gets an result search.
ResultSearchOrder	getResultSearchOrder() Gets an result search order.

Methods inherited from interface org.osid.offering.ResultQuerySession

canSearchResults, getCatalogue, getCatalogueId, getResultQuery, getResultsByQuery, useFederatedCatalogueView, useIsolatedCatalogueView

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

getResultSearch

ResultSearch getResultSearch()

Gets an result search.

Returns:

the result search

Compliance:

mandatory - This method must be implemented.

getResultSearchOrder

ResultSearchOrder getResultSearchOrder()

Gets an result search order. The ResultSearchOrder is supplied to an ResultSearch to specify the ordering of results.

Returns:

the result search order

Compliance:

mandatory - This method must be implemented.

getResultsBySearch

ResultSearchResults getResultsBySearch(ResultQuery resultQuery,
                                     ResultSearch resultSearch)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the search results matching the given search.

Parameters:

resultQuery - the result query

resultSearch - the result search

Returns:

the search results

Throws:

NullArgumentException - resultQuery or resultSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - resultQuery or resultSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getResultQueryFromInspector

ResultQuery getResultQueryFromInspector(ResultQueryInspector resultQueryInspector)

Gets an result query from an inspector. The inspector is available from an ResultSearchResults.

Parameters:

resultQueryInspector - an result query inspector

Returns:

the result query

Throws:

NullArgumentException - resultQueryInspector is null

UnsupportedException - resultQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.