OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.Block
Implementsosid.OsidObject
Description

A Block . A Block maps to a set of Issues and whose impact is interpreted outside this service.

MethodgetIssueIds
Description

Gets the Ids of the issues.

Returnosid.id.IdListthe issue Ids
CompliancemandatoryThis method must be implemented.
MethodgetIssues
Description

Gets the issues.

Returnosid.hold.IssueListthe issues
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetBlockRecord
Description

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

Parametersosid.type.TypeblockRecordTypethe type of block record to retrieve
Returnosid.hold.records.BlockRecordthe block record
ErrorsNULL_ARGUMENT blockRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(blockRecordType) is false
CompliancemandatoryThis method must be implemented.