OSID Logo
OSID Specifications
configuration rules package
Version 3.1.0
Interfaceosid.configuration.rules.ValueEnabler
Implementsosid.OsidEnabler
Used Byosid.configuration.rules.ValueEnablerAdminSession
osid.configuration.rules.ValueEnablerList
osid.configuration.rules.ValueEnablerLookupSession
Description

A ValueEnabler describes the rules for making a Value active.

MethodgetValueEnablerRecord
Description

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

Parametersosid.type.TypevalueEnablerRecordType the type of value enabler record to retrieve
Returnosid.configuration.rules.records.ValueEnablerRecord the value enabler record
ErrorsNULL_ARGUMENT valueEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(valueEnablerRecordType) is false
Compliancemandatory This method must be implemented.