Interface AwardEntry

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface AwardEntry extends OsidRelationship

An AwardEntry represents an academic record entry for a recognition.

  • Method Details

    • 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.

    • getAwardId

      Id getAwardId()
      Gets the Id of the Award.
      Returns:
      the award Id
      Compliance:
      mandatory - This method must be implemented.

    • getAward

      Award getAward() throws OperationFailedException
      Gets the Award.
      Returns:
      the award
      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 this award applies to a specific program. If hasProgram() is true, hasCourse() and hasAssessment() must be false.
      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.

    • hasCourse

      boolean hasCourse()
      Tests if this award applies to a specific course. If hasCourse() is true, hasProgram() and hasAssessment() must be false.
      Returns:
      true if a course is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseId

      Id getCourseId()
      Gets the Id of the Course.
      Returns:
      the course Id
      Throws:
      IllegalStateException - hasCourse() is false
      Compliance:
      mandatory - This method must be implemented.

    • getCourse

      Course getCourse() throws OperationFailedException
      Gets the Course.
      Returns:
      the course
      Throws:
      IllegalStateException - hasCourse() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasAssessment

      boolean hasAssessment()
      Tests if this award applies to a specific assessment. If hasAssessment() is true, hasCourse() and hasProgram() must be false.
      Returns:
      true if an assessment is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentId

      Id getAssessmentId()
      Gets the Id of the Assessment.
      Returns:
      the assessment Id
      Throws:
      IllegalStateException - hasAssessment() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAssessment

      Assessment getAssessment() throws OperationFailedException
      Gets the Assessment.
      Returns:
      the assessment
      Throws:
      IllegalStateException - hasAssessment() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAwardEntryRecord

      AwardEntryRecord getAwardEntryRecord(Type awardEntryRecordType) throws OperationFailedException
      Gets the award entry record corresponding to the given 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.
      Parameters:
      awardEntryRecordType - the type of award entry record to retrieve
      Returns:
      the award entry record
      Throws:
      NullArgumentException - awardEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(awardEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.