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

This is the form for creating and updating AwardEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AwardEntryAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetDateAwardedMetadata
Description

Gets the metadata for the award date.

Returnosid.Metadatametadata for the award date
CompliancemandatoryThis method must be implemented.
MethodsetDateAwarded
Description

Sets the award date.

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

Clears the award date.

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.
MethodgetAssessmentMetadata
Description

Gets the metadata for the assessment.

Returnosid.Metadatametadata for the assessment
CompliancemandatoryThis method must be implemented.
MethodsetAssessment
Description

Sets the assessment.

Parametersosid.id.IdassessmentIdthe new assessment
ErrorsINVALID_ARGUMENT assessmentId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT assessmentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssessment
Description

Clears the assessment.

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

Gets the AwardEntryFormRecord corresponding to the given award entry record Type.

Parametersosid.type.TypeawardEntryRecordTypean award entry record type
Returnosid.course.chronicle.records.AwardEntryFormRecordthe award entry form record
ErrorsNULL_ARGUMENT awardEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardEntryRecordType) is false
CompliancemandatoryThis method must be implemented.