OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.SearchProfile
Implementsosid.OsidProfile
Description

The search profile describes the interoperability among search services.

MethodsupportsVisibleFederation
Description

Tests if any engine federation is exposed. Federation is exposed when a specific engine may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of engines appears as a single engine.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSearch
Description

Tests if search is supported.

Returnboolean true if search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineLookup
Description

Tests for the availability of an engine lookup service.

Returnboolean true if engine lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineQuery
Description

Tests if querying for engines is available.

Returnboolean true if engine query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineSearch
Description

Tests if searching for engines is available.

Returnboolean true if engine search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineAdmin
Description

Tests for the availability of an engine administrative service for creating and deleting engines.

Returnboolean true if engine administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineNotification
Description

Tests for the availability of an engine notification service.

Returnboolean true if engine notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsEngineHierarchy
Description

Tests for the availability of an engine hierarchy traversal service.

Returnboolean true if engine hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineHierarchyDesign
Description

Tests for the availability of an engine hierarchy design service.

Returnboolean true if engine hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetQueryRecordTypes
Description

Gets the supported query record types.

Returnosid.type.TypeLista list containing the supported query record types
CompliancemandatoryThis method must be implemented.
MethodsupportsQueryRecordType
Description

Tests if the given query record type is supported.

Parametersosid.type.TypequeryRecordTypea Type indicating a query record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT queryRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSearchRecordTypes
Description

Gets the supported search record types.

Returnosid.type.TypeLista list containing the supported search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSearchRecordType
Description

Tests if the given search record type is supported.

Parametersosid.type.TypesearchRecordTypea Type indicating a search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT searchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetEngineRecordTypes
Description

Gets the supported Engine record types.

Returnosid.type.TypeLista list containing the supported engine record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineRecordType
Description

Tests if the given Engine record type is supported.

Parametersosid.type.TypeengineRecordTypea Type indicating an Engine record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT engineRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetEngineSearchRecordTypes
Description

Gets the supported engine search record types.

Returnosid.type.TypeLista list containing the supported engine search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEngineSearchRecordType
Description

Tests if the given engine search record type is supported.

Parametersosid.type.TypeengineSearchRecordTypea Type indicating an engine record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT engineSearchRecordType is null
CompliancemandatoryThis method must be implemented.