org.osid.hold

Interface BlockForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

BlockBatchForm

public interface BlockForm
extends OsidObjectForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearIssues() Removes the issues.
BlockFormRecord	getBlockFormRecord(Type blockRecordType) Gets the BlockFormRecord corresponding to the given block record Type.
Metadata	getIssuesMetadata() Gets the metadata for the issues.
void	setIssues(Id[] issueIds) Sets the issues.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getIssuesMetadata

Metadata getIssuesMetadata()

Gets the metadata for the issues.

Returns:

metadata for the issues

Compliance:

mandatory - This method must be implemented.

setIssues

void setIssues(Id[] issueIds)

Sets the issues.

Parameters:

issueIds - the new issues

Throws:

InvalidArgumentException - issueIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - issueIds is null

Compliance:

mandatory - This method must be implemented.

clearIssues

void clearIssues()

Removes the issues.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBlockFormRecord

BlockFormRecord getBlockFormRecord(Type blockRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the BlockFormRecord corresponding to the given block record Type.

Parameters:

blockRecordType - a block record type

Returns:

the block form 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.