OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.BlockForm
Implementsosid.OsidObjectForm
Implemented Byosid.hold.batch.BlockBatchForm
Used Byosid.hold.BlockAdminSession
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.Metadata metadata for the issues
Compliancemandatory This method must be implemented.
MethodsetIssues
Description

Sets the issues.

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

Removes the issues.

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

Gets the BlockFormRecord corresponding to the given block record Type.

Parametersosid.type.TypeblockRecordType a block record type
Returnosid.hold.records.BlockFormRecord the block form 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.