Interface AssessmentEntryQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface AssessmentEntryQuery extends OsidRelationshipQuery

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

  • Method Details

    • matchStudentId

      void matchStudentId(Id resourceId, boolean match)
      Sets the student Id for this query.
      Parameters:
      resourceId - a resource Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStudentIdTerms

      void clearStudentIdTerms()
      Clears the student Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentQuery

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

    • getStudentQuery

      ResourceQuery getStudentQuery()
      Gets the query for a student option. Multiple retrievals produce a nested OR term.
      Returns:
      a student query
      Throws:
      UnimplementedException - supportsStudentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentQuery()} is {@code true} .

    • clearStudentTerms

      void clearStudentTerms()
      Clears the student option terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAssessmentId

      void matchAssessmentId(Id assessmentId, boolean match)
      Sets the assessment Id for this query to match entries that have an entry for the given assessment.
      Parameters:
      assessmentId - an assessment Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentIdTerms

      void clearAssessmentIdTerms()
      Clears the assessment Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentQuery

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

    • getAssessmentQuery

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

    • clearAssessmentTerms

      void clearAssessmentTerms()
      Clears the assessment terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDateCompleted

      void matchDateCompleted(DateTime from, DateTime to, boolean match)
      Matches completed dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyDateCompleted

      void matchAnyDateCompleted(boolean match)
      Matches entries that have any completed date.
      Parameters:
      match - true to match entries with any completed date, false to match entries with no completed date
      Compliance:
      mandatory - This method must be implemented.

    • clearDateCompletedTerms

      void clearDateCompletedTerms()
      Clears the completed date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchProgramId

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

    • clearProgramIdTerms

      void clearProgramIdTerms()
      Clears the program Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProgramQuery

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

    • getProgramQuery

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

    • matchAnyProgram

      void matchAnyProgram(boolean match)
      Matches entries that have any program.
      Parameters:
      match - true to match entries with any program false to match entries with no program
      Compliance:
      mandatory - This method must be implemented.

    • clearProgramTerms

      void clearProgramTerms()
      Clears the program terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseId

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

    • clearCourseIdTerms

      void clearCourseIdTerms()
      Clears the course Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseQuery

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

    • getCourseQuery

      CourseQuery getCourseQuery()
      Gets the query for a course entry. Multiple retrievals produce a nested OR term.
      Returns:
      a course query
      Throws:
      UnimplementedException - supportsCourseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseQuery()} is {@code true} .

    • matchAnyCourse

      void matchAnyCourse(boolean match)
      Matches entries that have any course.
      Parameters:
      match - true to match entries with any course, false to match entries with no course
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseTerms

      void clearCourseTerms()
      Clears the course terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGradeId

      void matchGradeId(Id gradeId, boolean match)
      Matches a grade Id .
      Parameters:
      gradeId - a grade Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGradeIdTerms

      void clearGradeIdTerms()
      Clears the grade Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradeQuery

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

    • getGradeQuery

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

    • matchAnyGrade

      void matchAnyGrade(boolean match)
      Matches entries that have any grade.
      Parameters:
      match - true to match entries with any grade, false to match entries with no grade
      Compliance:
      mandatory - This method must be implemented.

    • clearGradeTerms

      void clearGradeTerms()
      Clears the grade terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScoreScaleId

      void matchScoreScaleId(Id gradeSystemId, boolean match)
      Matches a score scale Id .
      Parameters:
      gradeSystemId - a grade system Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearScoreScaleIdTerms

      void clearScoreScaleIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsScoreScaleQuery

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

    • getScoreScaleQuery

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

    • matchAnyScoreScale

      void matchAnyScoreScale(boolean match)
      Matches entries that have any score scale.
      Parameters:
      match - true to match entries with any score scale, false to match entries with no score scale
      Compliance:
      mandatory - This method must be implemented.

    • clearScoreScaleTerms

      void clearScoreScaleTerms()
      Clears the score scale terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScore

      void matchScore(BigDecimal from, BigDecimal to, boolean match)
      Matches scores between the given range inclusive.
      Parameters:
      from - starting value
      to - ending value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyScore

      void matchAnyScore(boolean match)
      Matches entries that have any score.
      Parameters:
      match - true to match entries with any score, false to match entries with no score
      Compliance:
      mandatory - This method must be implemented.

    • clearScoreTerms

      void clearScoreTerms()
      Clears the score terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseCatalogId

      void matchCourseCatalogId(Id courseCatalogId, boolean match)
      Sets the course catalog Id for this query to match entries assigned to course catalogs.
      Parameters:
      courseCatalogId - the course catalog Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - courseCatalogId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseCatalogIdTerms

      void clearCourseCatalogIdTerms()
      Clears the course catalog Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogQuery

      boolean supportsCourseCatalogQuery()
      Tests if a CourseCatalogQuery is available.
      Returns:
      true if a course catalog query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogQuery

      CourseCatalogQuery getCourseCatalogQuery()
      Gets the query for a course catalog. Multiple retrievals produce a nested OR term.
      Returns:
      the course catalog query
      Throws:
      UnimplementedException - supportsCourseCatalogQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .

    • clearCourseCatalogTerms

      void clearCourseCatalogTerms()
      Clears the course catalog terms.
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentEntryQueryRecord

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