Interface AssessmentQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable
public interface AssessmentQuery extends OsidObjectQuery

This is the query for searching assessments. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Like all OsidQueries, AssessmentQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchLevelId

      void matchLevelId(Id gradeId, boolean match)
      Sets the level grade Id for this query.
      Parameters:
      gradeId - a grade Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLevelIdTerms

      void clearLevelIdTerms()
      Clears all level Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLevelQuery

      boolean supportsLevelQuery()
      Tests if a GradeQuery is available.
      Returns:
      true if a grade query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLevelQuery

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

    • matchAnyLevel

      void matchAnyLevel(boolean match)
      Matches an assessment that has any level assigned.
      Parameters:
      match - true to match assessments with any level, false to match assessments with no level
      Compliance:
      mandatory - This method must be implemented.

    • clearLevelTerms

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

    • matchRubricId

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

    • clearRubricIdTerms

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

    • supportsRubricQuery

      boolean supportsRubricQuery()
      Tests if an AssessmentQuery is available.
      Returns:
      true if a rubric assessment query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRubricQuery

      AssessmentQuery getRubricQuery()
      Gets the query for a rubric assessment. Multiple retrievals produce a nested OR term.
      Returns:
      the assessment query
      Throws:
      UnimplementedException - supportsRubricQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRubricQuery()} is {@code true}.

    • matchAnyRubric

      void matchAnyRubric(boolean match)
      Matches an assessment that has any rubric assessment assigned.
      Parameters:
      match - true to match assessments with any rubric, false to match assessments with no rubric
      Compliance:
      mandatory - This method must be implemented.

    • clearRubricTerms

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

    • matchItemId

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

    • clearItemIdTerms

      void clearItemIdTerms()
      Clears all item Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemQuery

      boolean supportsItemQuery()
      Tests if an ItemQuery is available.
      Returns:
      true if an item query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getItemQuery

      ItemQuery getItemQuery()
      Gets the query for an item. Multiple retrievals produce a nested OR term.
      Returns:
      the item query
      Throws:
      UnimplementedException - supportsItemQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsItemQuery()} is {@code true}.

    • matchAnyItem

      void matchAnyItem(boolean match)
      Matches an assessment that has any item.
      Parameters:
      match - true to match assessments with any item, false to match assessments with no items
      Compliance:
      mandatory - This method must be implemented.

    • clearItemTerms

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

    • matchAssessmentOfferedId

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

    • clearAssessmentOfferedIdTerms

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

    • supportsAssessmentOfferedQuery

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

    • getAssessmentOfferedQuery

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

    • matchAnyAssessmentOffered

      void matchAnyAssessmentOffered(boolean match)
      Matches an assessment that has any offering.
      Parameters:
      match - true to match assessments with any offering, false to match assessments with no offerings
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentOfferedTerms

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

    • matchAssessmentTakenId

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

    • clearAssessmentTakenIdTerms

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

    • supportsAssessmentTakenQuery

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

    • getAssessmentTakenQuery

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

    • matchAnyAssessmentTaken

      void matchAnyAssessmentTaken(boolean match)
      Matches an assessment that has any taken version.
      Parameters:
      match - true to match assessments with any taken assessments, false to match assessments with no taken assessments
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentTakenTerms

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

    • matchBankId

      void matchBankId(Id bankId, boolean match)
      Sets the bank Id for this query.
      Parameters:
      bankId - a 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 all bank Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBankQuery

      boolean supportsBankQuery()
      Tests if a 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 all bank terms.
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentQueryRecord

      AssessmentQueryRecord getAssessmentQueryRecord(Type assessmentRecordType) throws OperationFailedException
      Gets the assessment query record corresponding to the given Assessment record Type. Multiple retrievals produce a nested OR term.
      Parameters:
      assessmentRecordType - an assessment record type
      Returns:
      the assessment query record
      Throws:
      NullArgumentException - assessmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(assessmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.