OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.SearchSession
Implementsosid.OsidSession
Description

This session provides methods to evaluate and execute search.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.search.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearch
Description

Tests if this user can evaluate search. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations.

Returnboolean false if evaluation methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedEngineView
Description

Federates the view for methods in this session. A federated view will include searches in engines which are children of this engine in the engine hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedEngineView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this engine only.

CompliancemandatoryThis method is must be implemented.
MethodgetQuery
Description

Gets the query interface.

Returnosid.search.Querythe returned Query interface
CompliancemandatoryThis method must be implemented.
MethodgetSearch
Description

Gets the search interface.

Returnosid.search.Searchthe returned Search interface
CompliancemandatoryThis method must be implemented.
Methodsearch
Description

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

Parametersosid.search.Queryquerya rule Id
osid.search.Searchsearchinput conditions
Returnosid.search.SearchResultsresult of the search
ErrorsNULL_ARGUMENT query or search is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED query or search not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueryFromInspector
Description

Gets a query interface from an inspector. The inspector is available from a SearchResults.

Parametersosid.search.QueryInspectorqueryInspectora query inspector
Returnosid.search.Querythe query interface
ErrorsNULL_ARGUMENT queryInspector is null
UNSUPPORTED queryInspector is not of this service
CompliancemandatoryThis method must be implemented.