Interface AwardEntrySearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface AwardEntrySearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByStudent

      void orderByStudent(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentSearchOrder

      boolean supportsStudentSearchOrder()
      Tests if a resource order is available.
      Returns:
      true if a resource order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStudentSearchOrder

      ResourceSearchOrder getStudentSearchOrder()
      Gets the resource order.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsStudentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentSearchOrder()} is {@code true} .

    • orderByAward

      void orderByAward(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the award.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAwardSearchOrder

      boolean supportsAwardSearchOrder()
      Tests if an award order is available.
      Returns:
      true if an award order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAwardSearchOrder

      AwardSearchOrder getAwardSearchOrder()
      Gets the award order.
      Returns:
      the award search order
      Throws:
      UnimplementedException - supportsAwardSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardSearchOrder()} is {@code true} .

    • orderByDateAwarded

      void orderByDateAwarded(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the award date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByProgram

      void orderByProgram(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the program.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsProgramSearchOrder

      boolean supportsProgramSearchOrder()
      Tests if a program order is available.
      Returns:
      true if a program order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProgramSearchOrder

      ProgramSearchOrder getProgramSearchOrder()
      Gets the program order.
      Returns:
      the program search order
      Throws:
      UnimplementedException - supportsProgramSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramSearchOrder()} is {@code true} .

    • orderByCourse

      void orderByCourse(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the course.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseSearchOrder

      boolean supportsCourseSearchOrder()
      Tests if a course order is available.
      Returns:
      true if a course order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseSearchOrder

      CourseSearchOrder getCourseSearchOrder()
      Gets the course order.
      Returns:
      the course search order
      Throws:
      UnimplementedException - supportsCourseSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseSearchOrder()} is {@code true} .

    • orderByAssessment

      void orderByAssessment(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the assessment.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentSearchOrder

      boolean supportsAssessmentSearchOrder()
      Tests if an assessment order is available.
      Returns:
      true if an assessment order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentSearchOrder

      AssessmentSearchOrder getAssessmentSearchOrder()
      Gets the assessment order.
      Returns:
      the assessment search order
      Throws:
      UnimplementedException - supportsAssessmentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentSearchOrder()} is {@code true} .

    • getAwardEntrySearchOrderRecord

      AwardEntrySearchOrderRecord getAwardEntrySearchOrderRecord(Type awardEntryRecordType) throws OperationFailedException
      Gets the award search order record corresponding to the given award entry record Type . Multiple retrievals return the same underlying object.
      Parameters:
      awardEntryRecordType - an award entry record type
      Returns:
      the award entry search order record
      Throws:
      NullArgumentException - awardEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(awardEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.