OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.Engine
Implementsosid.OsidCatalog
Description

An Engine represents a collection of rules. 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.TypeengineRecordTypethe type of engine record to retrieve
Returnosid.rules.records.EngineRecordthe engine record
ErrorsNULL_ARGUMENT engineRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(engineRecordType) is false
CompliancemandatoryThis method must be implemented.