org.osid.course.chronicle

Interface CredentialEntry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface CredentialEntry
extends OsidRelationship

A CredentialEntry represents an academic record entry for a credential.

Method Summary

Methods

Modifier and Type	Method and Description
Credential	getCredential() Gets the Credential.
CredentialEntryRecord	getCredentialEntryRecord(Type credentialEntryRecordType) Gets the credential entry record corresponding to the given CredentialEntry record Type.
Id	getCredentialId() Gets the Id of the Credential.
DateTime	getDateAwarded() Gets the award date.
Program	getProgram() Gets the Program.
Id	getProgramId() Gets the Id of the Program.
Resource	getStudent() Gets the Student.
Id	getStudentId() Gets the Id of the Student.
boolean	hasProgram() Tests if a program is associated with this credential.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getStudentId

Id getStudentId()

Gets the Id of the Student.

Returns:

the student Id

Compliance:

mandatory - This method must be implemented.

getStudent

Resource getStudent()
                    throws OperationFailedException

Gets the Student.

Returns:

the student

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCredentialId

Id getCredentialId()

Gets the Id of the Credential.

Returns:

the credential Id

Compliance:

mandatory - This method must be implemented.

getCredential

Credential getCredential()
                         throws OperationFailedException

Gets the Credential.

Returns:

the credential

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDateAwarded

DateTime getDateAwarded()

Gets the award date.

Returns:

the date awarded

Compliance:

mandatory - This method must be implemented.

hasProgram

boolean hasProgram()

Tests if a program is associated with this credential.

Returns:

true if a program is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramId

Id getProgramId()

Gets the Id of the Program.

Returns:

the program Id

Throws:

IllegalStateException - hasProgram() is false

Compliance:

mandatory - This method must be implemented.

getProgram

Program getProgram()
                   throws OperationFailedException

Gets the Program.

Returns:

the program

Throws:

IllegalStateException - hasProgram() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCredentialEntryRecord

CredentialEntryRecord getCredentialEntryRecord(Type credentialEntryRecordType)
                                               throws OperationFailedException

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 .

Parameters:

credentialEntryRecordType - the type of credential entry record to retrieve

Returns:

the credential entry record

Throws:

NullArgumentException - credentialEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.