OSID Logo
OSID Specifications
search package
Version 3.1.0
Interfaceosid.search.Engine
Implementsosid.OsidCatalog
Used Byosid.search.EngineAdminSession
osid.search.EngineList
osid.search.EngineLookupSession
osid.search.EngineNode
osid.search.SearchSession
Description

An Engine represents a search engine. Like all OSID objects, an Engine is identified by its Id and any persisted references should use the Id.

MethodgetEngineRecord
Description

Gets the engine record corresponding to the given Engine record Type.This method is used to retrieve an object implementing the requested record. The engineRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(engineRecordType) is true.

Parametersosid.type.TypeengineRecordType the type of engine record to retrieve
Returnosid.search.records.EngineRecord the engine record
ErrorsNULL_ARGUMENT engineRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(engineRecordType) is false
Compliancemandatory This method must be implemented.