OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
search package
Version 3.0.0
Release Candidate Preview
| Interface | osid.search.SearchSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to evaluate and execute search. | ||
| Method | getEngineId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Engine Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngine | ||
| Description |
Gets the | ||
| Return | osid.search.Engine | the engine | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSearch | ||
| 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 | ||
| Return | boolean | false if evaluation methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useFederatedEngineView | ||
| 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. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedEngineView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts searches to this engine only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getQuery | ||
| Description |
Gets the query interface. | ||
| Return | osid.search.Query | the returned Query interface | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSearch | ||
| Description |
Gets the search interface. | ||
| Return | osid.search.Search | the returned Search interface | |
| Compliance | mandatory | This method must be implemented. | |
| Method | search | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.search.Query | query | a rule Id |
osid.search.Search | search | input conditions | |
| Return | osid.search.SearchResults | result of the search | |
| Errors | NULL_ARGUMENT | query or search is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | query or search not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueryFromInspector | ||
| Description |
Gets a query interface from an inspector. The inspector
is available from a | ||
| Parameters | osid.search.QueryInspector | queryInspector | a query inspector |
| Return | osid.search.Query | the query interface | |
| Errors | NULL_ARGUMENT | queryInspector is null | |
| UNSUPPORTED | queryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |