OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.Block
Implementsosid.OsidObject
Used Byosid.hold.BlockAdminSession
osid.hold.BlockList
osid.hold.BlockLookupSession
osid.rules.check.Check
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.IdList the issue Ids
Compliancemandatory This method must be implemented.
MethodgetIssues
Description

Gets the issues.

Returnosid.hold.IssueList the issues
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypeblockRecordType the type of block record to retrieve
Returnosid.hold.records.BlockRecord the block record
ErrorsNULL_ARGUMENT blockRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(blockRecordType) is false
Compliancemandatory This method must be implemented.