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

This is the form for creating and updating CredentialEntries. 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.

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

Gets the CredentialEntryFormRecord corresponding to the given credential entry record Type.

Parametersosid.type.TypecredentialEntryRecordTypea credential entry record type
Returnosid.course.chronicle.records.CredentialEntryFormRecordthe credential entry form record
ErrorsNULL_ARGUMENT credentialEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialEntryRecordType) is false
CompliancemandatoryThis method must be implemented.