org.osid.assessment

Interface AssessmentTakenForm

All Superinterfaces:

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

All Known Subinterfaces:

AssessmentTakenBatchForm

public interface AssessmentTakenForm
extends OsidObjectForm

This is the form for creating and updating an AssessmentTaken. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AssessmentTakenAdminSession. 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	clearTaker() Clears the resource.
AssessmentTakenFormRecord	getAssessmentTakenFormRecord(Type assessmentTakenRecordType) Gets the AssessmentTakenFormRecord corresponding to the given assessment taken record Type.
Metadata	getTakerMetadata() Gets the metadata for a resource to manually set which resource will be taking the assessment.
void	setTaker(Id resourceId) Sets the resource who will be taking this assessment.

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

getTakerMetadata

Metadata getTakerMetadata()

Gets the metadata for a resource to manually set which resource will be taking the assessment.

Returns:

metadata for the resource

Compliance:

mandatory - This method must be implemented.

setTaker

void setTaker(Id resourceId)

Sets the resource who will be taking this assessment.

Parameters:

resourceId - the resource Id

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTaker

void clearTaker()

Clears the resource.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAssessmentTakenFormRecord

AssessmentTakenFormRecord getAssessmentTakenFormRecord(Type assessmentTakenRecordType)
                                                       throws OperationFailedException

Gets the AssessmentTakenFormRecord corresponding to the given assessment taken record Type.

Parameters:

assessmentTakenRecordType - the assessment taken record type

Returns:

the assessment taken record

Throws:

NullArgumentException - assessmentTakenRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentTakenRecordType) is false

Compliance:

mandatory - This method must be implemented.