Interface RegistrationRequestItemSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable
public interface RegistrationRequestItemSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByRegistrationRequest

      void orderByRegistrationRequest(SearchOrderStyle style)
      Orders the results by registration request.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationRequestSearchOrder

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

    • getRegistrationRequestSearchOrder

      RegistrationRequestSearchOrder getRegistrationRequestSearchOrder()
      Gets the registration request search order.
      Returns:
      the registration request search order
      Throws:
      IllegalStateException - supportsRegistrationRequestSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByStudent

      void orderByStudent(SearchOrderStyle style)
      Orders the results by student.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentSearchOrder

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

    • getStudentSearchOrder

      ResourceSearchOrder getStudentSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsStudentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByRegistrationOperation

      void orderByRegistrationOperation(SearchOrderStyle style)
      Orders the results by registration operation.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByExistingRegistration

      void orderByExistingRegistration(SearchOrderStyle style)
      Orders the results by existing registration.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsExistingRegistrationSearchOrder

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

    • getExistingRegistrationSearchOrder

      Registration getExistingRegistrationSearchOrder()
      Gets the registration search order.
      Returns:
      the registration search order
      Throws:
      IllegalStateException - supportsExistingRegistrationSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreditOption

      void orderByCreditOption(SearchOrderStyle style)
      Orders the results by credit option.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByGradingOption

      void orderByGradingOption(SearchOrderStyle style)
      Orders the results by grading option.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradingOptionSearchOrder

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

    • getGradingOptionSearchOrder

      GradeSystemSearchOrder getGradingOptionSearchOrder()
      Gets the grade system search order.
      Returns:
      the grade system search order
      Throws:
      IllegalStateException - supportsGradingOptionSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemSearchOrderRecord

      RegistrationRequestItemSearchOrderRecord getRegistrationRequestItemSearchOrderRecord(Type registrationRequestItemRecordType) throws OperationFailedException
      Gets the registration request item search order record corresponding to the given registration request item record Type. Multiple retrievals return the same underlying object.
      Parameters:
      registrationRequestItemRecordType - a registration request item record type
      Returns:
      the registration request item search order record
      Throws:
      NullArgumentException - registrationRequestItemRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(registrationRequestItemRecordType) is false
      Compliance:
      mandatory - This method must be implemented.