org.osid.assessment

Interface ItemForm

All Superinterfaces:

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

All Known Subinterfaces:

AnswerBatchForm, ItemBatchForm, QuestionBatchForm

public interface ItemForm
extends OsidObjectForm

This is the form for creating and updating Items. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ItemAdminSession. 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	clearLearningObjectives() Clears the learning objectives.
ItemFormRecord	getItemFormRecord(Type itemRecordType) Gets the ItemnFormRecord corresponding to the given item record Type.
Metadata	getLearningObjectivesMetadata() Gets the metadata for learning objectives.
void	setLearningObjectives(Id[] objectiveIds) Sets the learning objectives.

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

getLearningObjectivesMetadata

Metadata getLearningObjectivesMetadata()

Gets the metadata for learning objectives.

Returns:

metadata for the learning objectives

Compliance:

mandatory - This method must be implemented.

setLearningObjectives

void setLearningObjectives(Id[] objectiveIds)

Sets the learning objectives.

Parameters:

objectiveIds - the learning objective Ids

Throws:

InvalidArgumentException - objectiveIds is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearLearningObjectives

void clearLearningObjectives()

Clears the learning objectives.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getItemFormRecord

ItemFormRecord getItemFormRecord(Type itemRecordType)
                                 throws OperationFailedException

Gets the ItemnFormRecord corresponding to the given item record Type.

Parameters:

itemRecordType - the item record type

Returns:

the item record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.