OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.BlockForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating Blocks. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BlockAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetIssuesMetadata
Description

Gets the metadata for the issues.

Returnosid.Metadatametadata for the issues
CompliancemandatoryThis method must be implemented.
MethodsetIssues
Description

Sets the issues.

Parametersosid.id.Id[]issueIdsthe new issues
ErrorsINVALID_ARGUMENT issueIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT issueIds is null
CompliancemandatoryThis method must be implemented.
MethodclearIssues
Description

Removes the issues.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBlockFormRecord
Description

Gets the BlockFormRecord corresponding to the given block record Type.

Parametersosid.type.TypeblockRecordTypea block record type
Returnosid.hold.records.BlockFormRecordthe block form 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.