Interface | osid.grading.GradebookColumnQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Gradebook columns may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getGradebookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Gradebook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebook | ||
Description |
Gets the | ||
Return | osid.grading.Gradebook | the Gradebook associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchGradebookColumns | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedGradebookView | ||
Description |
Federates the view for methods in this session. A federated view will include gradebook columns in gradebooks which are children of this gradebook in the gradebook hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedGradebookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this gradebook only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getGradebookColumnQuery | ||
Description |
Gets a gradebook column query. | ||
Return | osid.grading.GradebookColumnQuery | the gradebook column | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnsByQuery | ||
Description |
Gets a list of gradebook columns matching the given query. | ||
Parameters | osid.grading.GradebookColumnQuery | gradebookColumnQuery | the gradebook column query |
Return | osid.grading.GradebookColumnList | the returned GradebookColumnList | |
Errors | NULL_ARGUMENT | gradebookColumnQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradebookColumnQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |