Interface SequenceRuleQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable
public interface SequenceRuleQuery extends OsidRuleQuery

This is the query for searching sequence rules. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchAssessmentPartId

      void matchAssessmentPartId(Id assessmentPartId, boolean match)
      Sets the assessment part Id for this query.
      Parameters:
      assessmentPartId - an assessment part Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentPartId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentPartIdTerms

      void clearAssessmentPartIdTerms()
      Clears all assessment part Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentPartQuery

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

    • getAssessmentPartQuery

      AssessmentPartQuery getAssessmentPartQuery()
      Gets the query for an assessment part. Multiple retrievals produce a nested OR term.
      Returns:
      the assessment part query
      Throws:
      UnimplementedException - supportsAssessmentPartQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentPartQuery()} is {@code true} .

    • clearAssessmentPartTerms

      void clearAssessmentPartTerms()
      Clears all assessment part terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchNextAssessmentPartId

      void matchNextAssessmentPartId(Id assessmentPartId, boolean match)
      Sets the assessment part Id for this query.
      Parameters:
      assessmentPartId - an assessment part Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentPartId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearNextAssessmentPartIdTerms

      void clearNextAssessmentPartIdTerms()
      Clears all assessment part Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsNextAssessmentPartQuery

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

    • getNextAssessmentPartQuery

      AssessmentPartQuery getNextAssessmentPartQuery()
      Gets the query for an assessment part. Multiple retrievals produce a nested OR term.
      Returns:
      the assessment part query
      Throws:
      UnimplementedException - supportsNextAssessmentPartQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsNextAssessmentPartQuery()} is {@code true} .

    • clearNextAssessmentPartTerms

      void clearNextAssessmentPartTerms()
      Clears all assessment part terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMinimumScore

      void matchMinimumScore(long low, long high, boolean match)
      Matches minimum scores that fall in between the given scores inclusive.
      Parameters:
      low - low end of range
      high - high end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - high is less than low
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumScore

      void matchAnyMinimumScore(boolean match)
      Matches assessment parts with any minimum score assigned.
      Parameters:
      match - true to match assessment parts with any minimum score, false to match assessment parts with no minimum score
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumScoreTerms

      void clearMinimumScoreTerms()
      Clears all minimum score terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMaximumScore

      void matchMaximumScore(long low, long high, boolean match)
      Matches maximum scores that fall in between the given scores inclusive.
      Parameters:
      low - low end of range
      high - high end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - high is less than low
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMaximumScore

      void matchAnyMaximumScore(boolean match)
      Matches assessment parts with any maximum score assigned.
      Parameters:
      match - true to match assessment parts with any maximum score, false to match assessment parts with no maximum score
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumScoreTerms

      void clearMaximumScoreTerms()
      Clears all maximum score terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCumulative

      void matchCumulative(boolean match)
      Matches cumulative rules.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearCumulativeTerms

      void clearCumulativeTerms()
      Clears all cumulative terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAppliedAssessmentPartId

      void matchAppliedAssessmentPartId(Id assessmentPartId, boolean match)
      Sets the assessment part Id for this query.
      Parameters:
      assessmentPartId - an assessment part Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentPartId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAppliedAssessmentPartIdTerms

      void clearAppliedAssessmentPartIdTerms()
      Clears all assessment part Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppliedAssessmentPartQuery

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

    • getAppliedAssessmentPartQuery

      AssessmentPartQuery getAppliedAssessmentPartQuery()
      Gets the query for an assessment part. Multiple retrievals produce a nested OR term.
      Returns:
      the assessment part query
      Throws:
      UnimplementedException - supportsAppliedAssessmentPartQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAppliedAssessmentPartQuery()} is {@code true} .

    • matchAnyAppliedAssessmentPart

      void matchAnyAppliedAssessmentPart(boolean match)
      Matches assessment parts with any applied assessment part.
      Parameters:
      match - true to match assessment parts with any applied assessment part, false to match assessment parts with no applied assessment parts
      Compliance:
      mandatory - This method must be implemented.

    • clearAppliedAssessmentPartTerms

      void clearAppliedAssessmentPartTerms()
      Clears all assessment part terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchBankId

      void matchBankId(Id bankId, boolean match)
      Matches constrainers mapped to the bank.
      Parameters:
      bankId - the bank Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - bankId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearBankIdTerms

      void clearBankIdTerms()
      Clears the bank Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBankQuery

      boolean supportsBankQuery()
      Tests if an BankQuery is available.
      Returns:
      true if a bank query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBankQuery

      BankQuery getBankQuery()
      Gets the query for a bank. Multiple retrievals produce a nested OR term.
      Returns:
      the bank query
      Throws:
      UnimplementedException - supportsBankQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBankQuery()} is {@code true} .

    • clearBankTerms

      void clearBankTerms()
      Clears the bank query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleQueryRecord

      SequenceRuleQueryRecord getSequenceRuleQueryRecord(Type sequenceRuleRecordType) throws OperationFailedException
      Gets the sequence rule query record corresponding to the given SequenceRule record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      sequenceRuleRecordType - a sequence rule record type
      Returns:
      the sequence rule query record
      Throws:
      NullArgumentException - sequenceRuleRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(sequenceRuleRecordType) is false
      Compliance:
      mandatory - This method must be implemented.