public interface CredentialEntry extends OsidRelationship
A CredentialEntry
represents an academic record entry
for a credential.
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.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getStudentId()
Id
of the Student.
Id
mandatory
- This method must be implemented. Resource getStudent() throws OperationFailedException
Student.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getCredentialId()
Id
of the Credential.
Id
mandatory
- This method must be implemented. Credential getCredential() throws OperationFailedException
Credential.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getDateAwarded()
mandatory
- This method must be implemented. boolean hasProgram()
true
if a program is available, false
otherwisemandatory
- This method must be implemented. Id getProgramId()
Id
of the Program.
Id
IllegalStateException
- hasProgram()
is
false
mandatory
- This method must be implemented. Program getProgram() throws OperationFailedException
Program.
IllegalStateException
- hasProgram()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CredentialEntryRecord getCredentialEntryRecord(Type credentialEntryRecordType) throws OperationFailedException
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
.credentialEntryRecordType
- the type of credential entry record
to retrieveNullArgumentException
-
credentialEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialEntryRecordType)
is
false
mandatory
- This method must be implemented.