OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ResultSearchSession
Implementsosid.offering.ResultQuerySession
Description

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.

MethodgetResultSearch
Description

Gets an result search.

Returnosid.offering.ResultSearchthe result search
CompliancemandatoryThis method must be implemented.
MethodgetResultSearchOrder
Description

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

Returnosid.offering.ResultSearchOrderthe result search order
CompliancemandatoryThis method must be implemented.
MethodgetResultsBySearch
Description

Gets the search results matching the given search.

Parametersosid.offering.ResultQueryresultQuerythe result query
osid.offering.ResultSearchresultSearchthe result search
Returnosid.offering.ResultSearchResultsthe search results
ErrorsNULL_ARGUMENT resultQuery or resultSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED resultQuery or resultSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetResultQueryFromInspector
Description

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

Parametersosid.offering.ResultQueryInspectorresultQueryInspectoran result query inspector
Returnosid.offering.ResultQuerythe result query
ErrorsNULL_ARGUMENT resultQueryInspector is null
UNSUPPORTED resultQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.