Interface EnrollmentSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByProgramOffering

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

    • supportsProgramOfferingSearchOrder

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

    • getProgramOfferingSearchOrder

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

    • orderByStudent

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

    • supportsStudentSearchOrder

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

    • getStudentSearchOrder

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

    • getEnrollmentSearchOrderRecord

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