org.osid.hold

Interface Block

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Block
extends OsidObject

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

Method Summary

Methods

Modifier and Type	Method and Description
BlockRecord	getBlockRecord(Type blockRecordType) Gets the block record corresponding to the given Block record Type.
IdList	getIssueIds() Gets the Ids of the issues.
IssueList	getIssues() Gets the issues.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getIssueIds

IdList getIssueIds()

Gets the Ids of the issues.

Returns:

the issue Ids

Compliance:

mandatory - This method must be implemented.

getIssues

IssueList getIssues()
                    throws OperationFailedException

Gets the issues.

Returns:

the issues

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getBlockRecord

BlockRecord getBlockRecord(Type blockRecordType)
                           throws OperationFailedException,
                                  PermissionDeniedException

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 .

Parameters:

blockRecordType - the type of block record to retrieve

Returns:

the block record

Throws:

NullArgumentException - blockRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(blockRecordType) is false

Compliance:

mandatory - This method must be implemented.