OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntry
Implementsosid.OsidRelationship
Description

A CredentialEntry represents an academic record entry for a credential.

MethodgetStudentId
Description

Gets the Id of the Student.

Returnosid.id.Idthe student Id
CompliancemandatoryThis method must be implemented.
MethodgetStudent
Description

Gets the Student.

Returnosid.resource.Resourcethe student
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCredentialId
Description

Gets the Id of the Credential.

Returnosid.id.Idthe credential Id
CompliancemandatoryThis method must be implemented.
MethodgetCredential
Description

Gets the Credential.

Returnosid.course.program.Credentialthe credential
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDateAwarded
Description

Gets the award date.

Returnosid.calendaring.DateTimethe date awarded
CompliancemandatoryThis method must be implemented.
MethodhasProgram
Description

Tests if a program is associated with this credential.

Returnboolean true if a program is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramId
Description

Gets the Id of the Program.

Returnosid.id.Idthe program Id
ErrorsILLEGAL_STATE hasProgram() is false
CompliancemandatoryThis method must be implemented.
MethodgetProgram
Description

Gets the Program.

Returnosid.course.program.Programthe program
ErrorsILLEGAL_STATE hasProgram() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntryRecord
Description

Gets the credential entry record corresponding to the given CredentialEntry record Type. This method is used to retrieve an object implementing the requested record. The credentialEntryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(credentialEntryRecordType) is true .

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