OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AssessmentEntryForm
Implementsosid.OsidRelationshipForm
Description

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.

MethodgetDateCompletedMetadata
Description

Gets the metadata for the completed date.

Returnosid.Metadatametadata for the completion date
CompliancemandatoryThis method must be implemented.
MethodsetDateCompleted
Description

Sets the completed date.

Parametersosid.calendaring.DateTimedatethe new completion date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearDateCompleted
Description

Clears the date completed.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetProgramMetadata
Description

Gets the metadata for the program.

Returnosid.Metadatametadata for the program
CompliancemandatoryThis method must be implemented.
MethodsetProgram
Description

Sets the program.

Parametersosid.id.IdprogramIdthe new program
ErrorsINVALID_ARGUMENT programId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT programId is null
CompliancemandatoryThis method must be implemented.
MethodclearProgram
Description

Clears the program.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCourseMetadata
Description

Gets the metadata for the course.

Returnosid.Metadatametadata for the course
CompliancemandatoryThis method must be implemented.
MethodsetCourse
Description

Sets the course.

Parametersosid.id.IdcourseIdthe new course
ErrorsINVALID_ARGUMENT courseId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT courseId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourse
Description

Clears the course.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetGradeMetadata
Description

Gets the metadata for the grade.

Returnosid.Metadatametadata for the grade
CompliancemandatoryThis method must be implemented.
MethodsetGrade
Description

Sets the grade.

Parametersosid.id.IdgradeIdthe new grade
ErrorsINVALID_ARGUMENT gradeId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeId is null
CompliancemandatoryThis method must be implemented.
MethodclearGrade
Description

Clears the grade.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetScoreScaleMetadata
Description

Gets the metadata for the score system.

Returnosid.Metadatametadata for the grade system
CompliancemandatoryThis method must be implemented.
MethodsetScoreScale
Description

Sets the score system.

Parametersosid.id.IdgradeSystemIdthe new grade system
ErrorsINVALID_ARGUMENT gradeSystemId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeSystemId is null
CompliancemandatoryThis method must be implemented.
MethodclearScoreScale
Description

Clears the score system.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetScoreMetadata
Description

Gets the metadata for the score.

Returnosid.Metadatametadata for the score
CompliancemandatoryThis method must be implemented.
MethodsetScore
Description

Sets the score.

Parametersdecimalscorethe new score
ErrorsINVALID_ARGUMENT score is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearScore
Description

Clears the score.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntryFormRecord
Description

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

Parametersosid.type.TypeassessmentEntryRecordTypean assessment entry record type
Returnosid.course.chronicle.records.AssessmentEntryFormRecordthe assessment entry form record
ErrorsNULL_ARGUMENT assessmentEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assessmentEntryRecordType) is false
CompliancemandatoryThis method must be implemented.