OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.Hold
Implementsosid.OsidRelationship
Used Byosid.hold.HoldAdminSession
osid.hold.HoldList
osid.hold.HoldLookupSession
Description

A Hold is an Issue applicable to a Resource. The effective dates of the relationship specify the duration of the hold.

Like all OsidObjects, Hold is managed by its OsidSessions and may not be accessed by concurrent processing threads.

MethodgetIssueId
Description

Gets the Id of the issue.

Returnosid.id.Id the issue Id
Compliancemandatory This method must be implemented.
MethodgetIssue
Description

Gets the issue.

Returnosid.hold.Issue the issue
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetResourceId
Description

Gets the Resource Id for this hold.

Returnosid.id.Id the resource Id
Compliancemandatory This method must be implemented.
MethodgetResource
Description

Gets the Resource for this hold.

Returnosid.resource.Resource the resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetHoldRecord
Description

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

Parametersosid.type.TypeholdRecordType the type of hold record to retrieve
Returnosid.hold.records.HoldRecord the hold record
ErrorsNULL_ARGUMENT holdRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(holdRecordType) is false
Compliancemandatory This method must be implemented.