OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.HoldForm
Implementsosid.OsidRelationshipForm
Description

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

MethodgetHoldFormRecord
Description

Gets the HoldFormRecord corresponding to the given hold record Type.

Parametersosid.type.TypeholdRecordTypea hold record type
Returnosid.hold.records.HoldFormRecordthe hold form record
ErrorsNULL_ARGUMENT holdRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(holdRecordType) is false
CompliancemandatoryThis method must be implemented.