public interface AwardEntry extends OsidRelationship
An AwardEntry
represents an academic record entry for a
recognition.
Modifier and Type | Method and Description |
---|---|
Assessment |
getAssessment()
Gets the
Assessment. |
Id |
getAssessmentId()
Gets the
Id of the Assessment. |
Award |
getAward()
Gets the
Award. |
AwardEntryRecord |
getAwardEntryRecord(Type awardEntryRecordType)
Gets the award entry record corresponding to the given
AwardEntry record Type. |
Id |
getAwardId()
Gets the
Id of the Award. |
Course |
getCourse()
Gets the
Course. |
Id |
getCourseId()
Gets the
Id of the Course. |
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 |
hasAssessment()
Tests if this award applies to a specific assessment.
|
boolean |
hasCourse()
Tests if this award applies to a specific course.
|
boolean |
hasProgram()
Tests if this award applies to a specific program.
|
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 getAwardId()
Id
of the Award.
Id
mandatory
- This method must be implemented. Award getAward() throws OperationFailedException
Award.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getDateAwarded()
mandatory
- This method must be implemented. boolean hasProgram()
hasProgram()
is true,
hasCourse()
and hasAssessment()
must be false. 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. boolean hasCourse()
hasCourse()
is true,
hasProgram()
and hasAssessment()
must be false.
true
if a course is available, false
otherwisemandatory
- This method must be implemented. Id getCourseId()
Id
of the Course.
Id
IllegalStateException
- hasCourse()
is
false
mandatory
- This method must be implemented. Course getCourse() throws OperationFailedException
Course.
IllegalStateException
- hasCourse()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasAssessment()
hasAssessment()
is true,
hasCourse()
and hasProgram()
must be false.
true
if an assessment is available,
false
otherwisemandatory
- This method must be implemented. Id getAssessmentId()
Id
of the Assessment.
Id
IllegalStateException
- hasAssessment()
is false
mandatory
- This method must be implemented. Assessment getAssessment() throws OperationFailedException
Assessment.
IllegalStateException
- hasAssessment()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. AwardEntryRecord getAwardEntryRecord(Type awardEntryRecordType) throws OperationFailedException
AwardEntry
record Type.
This method is used to
retrieve an object implementing the requested record. The
awardEntryRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(awardEntryRecordType)
is true
.awardEntryRecordType
- the type of award entry record to
retrieveNullArgumentException
- awardEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardEntryRecordType)
is false
mandatory
- This method must be implemented.