Interface GradebookQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface GradebookQuery extends OsidCatalogQuery

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

  • Method Details

    • 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.
      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 gradebooks that have any grade.
      Parameters:
      match - true to match gradebooks with any grade, false to match gradebooks with no grade
      Compliance:
      mandatory - This method must be implemented.

    • clearGradeTerms

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

    • matchGradeSystemId

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

    • clearGradeSystemIdTerms

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

    • supportsGradeSystemQuery

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

    • getGradeSystemQuery

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

    • matchAnyGradeSystem

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

    • clearGradeSystemTerms

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

    • matchGradeEntryId

      void matchGradeEntryId(Id gradeEntryId, boolean match)
      Sets the grade entry Id for this query.
      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.

    • clearGradeEntryIdTerms

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

    • supportsGradeEntryQuery

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

    • getGradeEntryQuery

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

    • matchAnyGradeEntry

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

    • clearGradeEntryTerms

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

    • 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.
      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} .

    • matchAnyGradebookColumn

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

    • clearGradebookColumnTerms

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

    • matchAncestorGradebookId

      void matchAncestorGradebookId(Id gradebookId, boolean match)
      Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as an ancestor.
      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.

    • clearAncestorGradebookIdTerms

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

    • supportsAncestorGradebookQuery

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

    • getAncestorGradebookQuery

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

    • matchAnyAncestorGradebook

      void matchAnyAncestorGradebook(boolean match)
      Matches gradebook with any ancestor.
      Parameters:
      match - true to match gradebooks with any ancestor, false to match root gradebooks
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorGradebookTerms

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

    • matchDescendantGradebookId

      void matchDescendantGradebookId(Id gradebookId, boolean match)
      Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as a descendant.
      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.

    • clearDescendantGradebookIdTerms

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

    • supportsDescendantGradebookQuery

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

    • getDescendantGradebookQuery

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

    • matchAnyDescendantGradebook

      void matchAnyDescendantGradebook(boolean match)
      Matches gradebook with any descendant.
      Parameters:
      match - true to match gradebooks with any descendant, false to match leaf gradebooks
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantGradebookTerms

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

    • getGradebookQueryRecord

      GradebookQueryRecord getGradebookQueryRecord(Type gradebookRecordType) throws OperationFailedException
      Gets the gradebook query record corresponding to the given Gradebook record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      gradebookRecordType - a gradebook record type
      Returns:
      the gradebook query record
      Throws:
      NullArgumentException - gradebookRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(gradebookRecordType) is false
      Compliance:
      mandatory - This method must be implemented.