Interface GradeEntryQuery

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

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

  • Method Details

    • matchGradebookColumnId

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

    • clearGradebookColumnIdTerms

      void clearGradebookColumnIdTerms()
      Clears the gradebook column Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradebookColumnQuery

      boolean supportsGradebookColumnQuery()
      Tests if a GradebookColumnQuery is available for querying creators.
      Returns:
      true if a gradebook column query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnQuery

      GradebookColumnQuery getGradebookColumnQuery()
      Gets the query for a gradebook column. Multiple retrievals produce a nested OR term.
      Returns:
      the gradebook column query
      Throws:
      UnimplementedException - supportsGradebookColumnQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradebookColumnQuery()} is {@code true} .

    • clearGradebookColumnTerms

      void clearGradebookColumnTerms()
      Clears the gradebook column terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchKeyResourceId

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

    • clearKeyResourceIdTerms

      void clearKeyResourceIdTerms()
      Clears the key resource Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsKeyResourceQuery

      boolean supportsKeyResourceQuery()
      Tests if a ResourceQUery is available for querying key resources.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getKeyResourceQuery

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

    • matchAnyKeyResource

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

    • clearKeyResourceTerms

      void clearKeyResourceTerms()
      Clears the key resource terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDerived

      void matchDerived(boolean match)
      Matches derived grade entries.
      Parameters:
      match - true to match derived grade entries , false to match manual entries
      Compliance:
      mandatory - This method must be implemented.

    • clearDerivedTerms

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

    • matchOverriddenGradeEntryId

      void matchOverriddenGradeEntryId(Id gradeEntryId, boolean match)
      Sets the grade entry Id for an overridden calculated grade entry.
      Parameters:
      gradeEntryId - a grade entry Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeEntryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOverriddenGradeEntryIdTerms

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

    • supportsOverriddenGradeEntryQuery

      boolean supportsOverriddenGradeEntryQuery()
      Tests if a GradeEntry is available for querying overridden calculated grade entries.
      Returns:
      true if a grade entry query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getOverriddenGradeEntryQuery

      GradeEntryQuery getOverriddenGradeEntryQuery()
      Gets the query for an overridden derived grade entry. Multiple retrievals produce a nested OR term.
      Returns:
      the grade entry query
      Throws:
      UnimplementedException - supportsOverriddenGradeEntryQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOverriddenGradeEntryQuery()} is {@code true} .

    • matchAnyOverriddenGradeEntry

      void matchAnyOverriddenGradeEntry(boolean match)
      Matches grade entries overriding any calculated grade entry.
      Parameters:
      match - true to match grade entries overriding any grade entry, false to match entries not overriding any entry
      Compliance:
      mandatory - This method must be implemented.

    • clearOverriddenGradeEntryTerms

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

    • matchIgnoredForCalculations

      void matchIgnoredForCalculations(boolean match)
      Matches grade entries ignored for calculations.
      Parameters:
      match - true to match grade entries ignored for calculations, false to match entries used in calculations
      Compliance:
      mandatory - This method must be implemented.

    • clearIgnoredForCalculationsTerms

      void clearIgnoredForCalculationsTerms()
      Clears the ignored for calculation entries terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGradeId

      void matchGradeId(Id gradeId, boolean match)
      Sets the 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.

    • clearGradeIdTerms

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

    • supportsGradeQuery

      boolean supportsGradeQuery()
      Tests if a GradeQuery is available for querying grades.
      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:
      the grade 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 grade entries with any grade.
      Parameters:
      match - true to match grade 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.

    • matchScore

      void matchScore(BigDecimal start, BigDecimal end, boolean match)
      Matches grade entries which score is between the specified score inclusive.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - end is less than start
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyScore

      void matchAnyScore(boolean match)
      Matches grade entries with any score.
      Parameters:
      match - true to match grade 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.

    • matchTimeGraded

      void matchTimeGraded(DateTime start, DateTime end, boolean match)
      Matches grade entries which graded time is between the specified times inclusive.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - end is less than start
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeGradedTerms

      void clearTimeGradedTerms()
      Clears the time graded terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGraderId

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

    • clearGraderIdTerms

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

    • supportsGraderQuery

      boolean supportsGraderQuery()
      Tests if a ResourceQuery is available for querying graders.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGraderQuery

      ResourceQuery getGraderQuery()
      Gets the query for an agent. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsResourceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

    • matchAnyGrader

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

    • clearGraderTerms

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

    • matchGradingAgentId

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

    • clearGradingAgentIdTerms

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

    • supportsGradingAgentQuery

      boolean supportsGradingAgentQuery()
      Tests if an AgentQuery is available for querying grading agents.
      Returns:
      true if an agent query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingAgentQuery

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

    • matchAnyGradingAgent

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

    • clearGradingAgentTerms

      void clearGradingAgentTerms()
      Clears the grading agent terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGradebookId

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

    • clearGradebookIdTerms

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

    • supportsGradebookQuery

      boolean supportsGradebookQuery()
      Tests if a GradebookQuery is available for querying resources.
      Returns:
      true if a gradebook query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookQuery

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

    • clearGradebookTerms

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

    • getGradeEntryQueryRecord

      GradeEntryQueryRecord getGradeEntryQueryRecord(Type gradeEntryRecordType) throws OperationFailedException
      Gets the grade entry query record corresponding to the given GradeEntry record Type . Multiple retrievals produce a nested OR term.
      Parameters:
      gradeEntryRecordType - a grade entry record type
      Returns:
      the grade entry query record
      Throws:
      NullArgumentException - gradeEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(gradeEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.