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

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

MethodgetAdmissionDateMetadata
Description

Gets the metadata for the admission date.

Returnosid.Metadatametadata for the admission date
CompliancemandatoryThis method must be implemented.
MethodsetAdmissionDate
Description

Sets the admission 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.
MethodclearAdmissionDate
Description

Clears the admission date.

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

Gets the metadta for the completionm flag.

Returnosid.Metadatametadata for the complete flag
CompliancemandatoryThis method must be implemented.
MethodsetComplete
Description

Sets the program is complete flag.

Parametersbooleancompletethe new complete flag
ErrorsINVALID_ARGUMENT complete is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearComplete
Description

Clears the complete flag.

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

Gets the metadata for the term.

Returnosid.Metadatametadata for the term
CompliancemandatoryThis method must be implemented.
MethodsetTerm
Description

Sets the term.

Parametersosid.id.IdtermIdthe new term
ErrorsINVALID_ARGUMENT termId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT termId is null
CompliancemandatoryThis method must be implemented.
MethodclearTerm
Description

Clears the term.

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

Gets the metadata for the credit scale.

Returnosid.Metadatametadata for the credit scale
CompliancemandatoryThis method must be implemented.
MethodsetCreditScale
Description

Sets the credit scale.

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

Clears the credit scale.

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

Gets the metadata for the credits earned.

Returnosid.Metadatametadata for the credits earned
CompliancemandatoryThis method must be implemented.
MethodsetCreditsEarned
Description

Sets the credits earned.

Parametersdecimalcreditsthe new credits
ErrorsINVALID_ARGUMENT credits is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCreditsEarned
Description

Clears the credits earned.

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

Gets the metadata for the gpa scale.

Returnosid.Metadatametadata for the gpa scale
CompliancemandatoryThis method must be implemented.
MethodsetGPAScale
Description

Sets the gpa scale.

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

Clears the gpa scale.

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

Gets the metadata for the gpa.

Returnosid.Metadatametadata for the gpa
CompliancemandatoryThis method must be implemented.
MethodsetGPA
Description

Sets the gpa.

Parametersdecimalgpathe new gpa
ErrorsINVALID_ARGUMENT gpa is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearGPA
Description

Clears the gpa.

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

Gets the ProgramEntryFormRecord corresponding to the given program entry record Type.

Parametersosid.type.TypeprogramEntryRecordTypea program entry record type
Returnosid.course.chronicle.records.ProgramEntryFormRecordthe program entry form record
ErrorsNULL_ARGUMENT programEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programEntryRecordType) is false
CompliancemandatoryThis method must be implemented.