OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnabler
Implementsosid.OsidEnabler
Description

A HoldEnabler describes the rules for making Holds effective.

MethodgetHoldEnablerRecord
Description

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

Parametersosid.type.TypeholdEnablerRecordTypethe type of hold enabler record to retrieve
Returnosid.hold.rules.records.HoldEnablerRecordthe hold enabler record
ErrorsNULL_ARGUMENT holdEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(holdEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.