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

Modifier and Type	Method	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	getAssessmentEntryFormRecord(Type assessmentEntryFormRecordType)	Gets the AssessmentEntryFormRecord 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(BigDecimal score)	Sets the score.
void	setScoreScale(Id gradeSystemId)	Sets the score system.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

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(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.

getAssessmentEntryFormRecord

AssessmentEntryFormRecord getAssessmentEntryFormRecord(Type assessmentEntryFormRecordType)
                                                throws OperationFailedException

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

Parameters:

assessmentEntryFormRecordType - an assessment entry record type

Returns:

the assessment entry form record

Throws:

NullArgumentException - assessmentEntryFormRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentEntryFormRecordType) is false

Compliance:

mandatory - This method must be implemented.