OSID Logo
OSID Specifications
search package
Version 3.1.0
Interfaceosid.search.EngineForm
Implementsosid.OsidCatalogForm
Used Byosid.search.EngineAdminSession
Description

This is the form for creating and updating Engines. Like all OsidForms, various data elements may be set here for use in the create and update methods in the EngineAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetEngineFormRecord
Description

Gets the EngineFormRecord corresponding to the given engine record Type.

Parametersosid.type.TypeengineRecordType the engine record type
Returnosid.search.records.EngineFormRecord the 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.