OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.HoldForm
Implementsosid.OsidRelationshipForm
Implemented Byosid.hold.batch.HoldBatchForm
Used Byosid.hold.HoldAdminSession
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.TypeholdRecordType a hold record type
Returnosid.hold.records.HoldFormRecord the hold form record
ErrorsNULL_ARGUMENT holdRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(holdRecordType) is false
Compliancemandatory This method must be implemented.