OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerForm
Implementsosid.OsidEnablerForm
Description

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

MethodgetHoldEnablerFormRecord
Description

Gets the HoldEnablerFormRecord corresponding to the given hold enabler record Type.

Parametersosid.type.TypeholdEnablerRecordTypea hold enabler record type
Returnosid.hold.rules.records.HoldEnablerFormRecordthe hold enabler form record
ErrorsNULL_ARGUMENT holdEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(holdEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.