Interface | osid.grading.GradebookQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching gradebooks. Each method
specifies an | ||
Method | matchGradeSystemId | ||
Description |
Sets the grade system | ||
Parameters | osid.id.Id | gradeSystemId | a grade system Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeSystemIdTerms | ||
Description |
Clears the grade system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeSystemQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeSystemQuery | ||
Description |
Gets the query for a grade system. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeSystemQuery | the grade system query | |
Errors | UNIMPLEMENTED | supportsGradeSystemQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradeSystemQuery()
is true. | |
Method | matchAnyGradeSystem | ||
Description |
Matches gradebooks that have any grade system. | ||
Parameters | boolean | match | true to match gradebooks with any grade system, false
to match gradebooks with no grade system |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeSystemTerms | ||
Description |
Clears the grade system terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGradeEntryId | ||
Description |
Sets the grade entry | ||
Parameters | osid.id.Id | gradeEntryId | a grade entry Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeEntryIdTerms | ||
Description |
Clears the grade entry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeEntryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade entry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeEntryQuery | ||
Description |
Gets the query for a grade entry. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeEntryQuery | the grade entry query | |
Errors | UNIMPLEMENTED | supportsGradeEntryQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradeEntryQuery()
is true. | |
Method | matchAnyGradeEntry | ||
Description |
Matches gradebooks that have any grade entry. | ||
Parameters | boolean | match | true to match gradebooks with any grade entry, false
to match gradebooks with no grade entry |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeEntryTerms | ||
Description |
Clears the grade entry terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGradebookColumnId | ||
Description |
Sets the gradebook column | ||
Parameters | osid.id.Id | gradebookColumnId | a gradebook column Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradebookColumnId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradebookColumnIdTerms | ||
Description |
Clears the gradebook column | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradebookColumnQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a gradebook column query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnQuery | ||
Description |
Gets the query for a gradebook column. Multiple
retrievals produce a nested | ||
Return | osid.grading.GradebookColumnQuery | the gradebook column query | |
Errors | UNIMPLEMENTED | supportsGradebookColumnQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradebookColumnQuery()
is true. | |
Method | matchAnyGradebookColumn | ||
Description |
Matches gradebooks that have any column. | ||
Parameters | boolean | match | true to match gradebooks with any column, false
to match gradebooks with no column |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradebookColumnTerms | ||
Description |
Clears the gradebook column terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorGradebookId | ||
Description |
Sets the gradebook | ||
Parameters | osid.id.Id | gradebookId | a gradebook Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradebookId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorGradebookIdTerms | ||
Description |
Clears the ancestor gradebook | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorGradebookQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a gradebook query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorGradebookQuery | ||
Description |
Gets the query for a gradebook. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradebookQuery | the gradebook query | |
Errors | UNIMPLEMENTED | supportsAncestorGradebookQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorGradebookQuery()
is true. | |
Method | matchAnyAncestorGradebook | ||
Description |
Matches gradebook with any ancestor. | ||
Parameters | boolean | match | true to match gradebooks with any ancestor, false
to match root gradebooks |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorGradebookTerms | ||
Description |
Clears the ancestor gradebook terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantGradebookId | ||
Description |
Sets the gradebook | ||
Parameters | osid.id.Id | gradebookId | a gradebook Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradebookId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantGradebookIdTerms | ||
Description |
Clears the descendant gradebook | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantGradebookQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a gradebook query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantGradebookQuery | ||
Description |
Gets the query for a gradebook. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradebookQuery | the gradebook query | |
Errors | UNIMPLEMENTED | supportsDescendantGradebookQuery() is false | |
Compliance | optional | This method must be implemented if
supportsDescendantGradebookQuery() is true. | |
Method | matchAnyDescendantGradebook | ||
Description |
Matches gradebook with any descendant. | ||
Parameters | boolean | match | true to match gradebooks with any descendant, false
to match leaf gradebooks |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantGradebookTerms | ||
Description |
Clears the descendant gradebook terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookQueryRecord | ||
Description |
Gets the gradebook query record corresponding to the
given | ||
Parameters | osid.type.Type | gradebookRecordType | a gradebook record type |
Return | osid.grading.records.GradebookQueryRecord | the gradebook query record | |
Errors | NULL_ARGUMENT | gradebookRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(gradebookRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |