Interface InquirySearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable
public interface InquirySearchOrder extends OsidRuleSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAudit

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

    • supportsAuditSearchOrder

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

    • getAuditSearchOrder

      AuditSearchOrder getAuditSearchOrder()
      Gets the audit search order.
      Returns:
      the audit search order
      Throws:
      IllegalStateException - supportsAuditSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByQuestion

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

    • orderByRequired

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

    • orderByAffirmationRequired

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

    • orderByNeedsOneResponse

      void orderByNeedsOneResponse(SearchOrderStyle style)
      Orders the results by the needs one response flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getInquirySearchOrderRecord

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