org.osid.course.chronicle

Interface AssessmentEntryForm

All Superinterfaces:

Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

All Known Subinterfaces:

AssessmentEntryBatchForm

public interface AssessmentEntryForm
extends OsidRuleForm, OsidAggregateableForm

This is the form for creating and updating AssessmentEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ChronicleAdminSession. 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	clearCourse() Clears the course.
void	clearDateCompleted() Clears the date completed.
void	clearGrade() Clears the grade.
void	clearProgram() Clears the program.
void	clearScore() Clears the score.
void	clearScoreScale() Clears the score system.
AssessmentEntryFormRecord	getAssessmentlEntryFormRecord(Type assessmentEntryRecordType) Gets the AssessmentlEntryFormRecord corresponding to the given assessment entry record Type.
Metadata	getCourseMetadata() Gets the metadata for the course.
Metadata	getDateCompletedMetadata() Gets the metadata for the completed date.
Metadata	getGradeMetadata() Gets the metadata for the grade.
Metadata	getProgramMetadata() Gets the metadata for the program.
Metadata	getScoreMetadata() Gets the metadata for the score.
Metadata	getScoreScaleMetadata() Gets the metadata for the score system.
void	setCourse(Id courseId) Sets the course.
void	setDateCompleted(DateTime date) Sets the completed date.
void	setGrade(Id gradeId) Sets the grade.
void	setProgram(Id programId) Sets the program.
void	setScore(java.math.BigDecimal score) Sets the score.
void	setScoreScale(Id gradeSystemId) Sets the score system.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getDateCompletedMetadata

Metadata getDateCompletedMetadata()

Gets the metadata for the completed date.

Returns:

metadata for the completion date

Compliance:

mandatory - This method must be implemented.

setDateCompleted

void setDateCompleted(DateTime date)

Sets the completed date.

Parameters:

date - the new completion date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDateCompleted

void clearDateCompleted()

Clears the date completed.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProgramMetadata

Metadata getProgramMetadata()

Gets the metadata for the program.

Returns:

metadata for the program

Compliance:

mandatory - This method must be implemented.

setProgram

void setProgram(Id programId)

Sets the program.

Parameters:

programId - the new program

Throws:

InvalidArgumentException - programId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - programId is null

Compliance:

mandatory - This method must be implemented.

clearProgram

void clearProgram()

Clears the program.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCourseMetadata

Metadata getCourseMetadata()

Gets the metadata for the course.

Returns:

metadata for the course

Compliance:

mandatory - This method must be implemented.

setCourse

void setCourse(Id courseId)

Sets the course.

Parameters:

courseId - the new course

Throws:

InvalidArgumentException - courseId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - courseId is null

Compliance:

mandatory - This method must be implemented.

clearCourse

void clearCourse()

Clears the course.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getGradeMetadata

Metadata getGradeMetadata()

Gets the metadata for the grade.

Returns:

metadata for the grade

Compliance:

mandatory - This method must be implemented.

setGrade

void setGrade(Id gradeId)

Sets the grade.

Parameters:

gradeId - the new grade

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearGrade

void clearGrade()

Clears the grade.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getScoreScaleMetadata

Metadata getScoreScaleMetadata()

Gets the metadata for the score system.

Returns:

metadata for the grade system

Compliance:

mandatory - This method must be implemented.

setScoreScale

void setScoreScale(Id gradeSystemId)

Sets the score system.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearScoreScale

void clearScoreScale()

Clears the score system.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getScoreMetadata

Metadata getScoreMetadata()

Gets the metadata for the score.

Returns:

metadata for the score

Compliance:

mandatory - This method must be implemented.

setScore

void setScore(java.math.BigDecimal score)

Sets the score.

Parameters:

score - the new score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearScore

void clearScore()

Clears the score.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAssessmentlEntryFormRecord

AssessmentEntryFormRecord getAssessmentlEntryFormRecord(Type assessmentEntryRecordType)
                                                        throws OperationFailedException

Gets the AssessmentlEntryFormRecord corresponding to the given assessment entry record Type.

Parameters:

assessmentEntryRecordType - an assessment entry record type

Returns:

the assessment entry form record

Throws:

NullArgumentException - assessmentEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.