Interface SequenceRuleSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAssessmentPart

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

    • supportsAssessmentPartSearchOrder

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

    • getAssessmentPartSearchOrder

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

    • orderByNextAssessmentPart

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

    • supportsNextAssessmentPartSearchOrder

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

    • getNextAssessmentPartSearchOrder

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

    • orderByMinimumScore

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

    • orderByMaximumScore

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

    • orderByCumulative

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

    • getSequenceRuleSearchOrderRecord

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