Interface | osid.grading.GradebookColumnLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Gradebook columns may have an additional records indicated
by their respective record types. The record may not be
accessed through a cast of 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 | canLookupGradebookColumns | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeGradebookColumnView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryGradebookColumnView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 lookups to this gradebook only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getGradebookColumn | ||
Description |
Gets the | ||
Parameters | osid.id.Id | gradebookColumnId | Id of the GradebookColumn |
Return | osid.grading.GradebookColumn | the gradebook column | |
Errors | NOT_FOUND | gradebookColumnId not found | |
NULL_ARGUMENT | gradebookColumnId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getGradebookColumnsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | gradebookColumnIds | the list of Ids to retrieve |
Return | osid.grading.GradebookColumnList | the returned GradebookColumn list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | gradeBookColumnIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | gradebookColumnGenusType | a gradebook column genus type |
Return | osid.grading.GradebookColumnList | the returned GradebookColumn list | |
Errors | NULL_ARGUMENT | gradebookColumnGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | gradebookColumnGenusType | a gradebook column genus type |
Return | osid.grading.GradebookColumnList | the returned GradebookColumn list | |
Errors | NULL_ARGUMENT | gradebookColumnGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | gradebookColumnRecordType | a gradebook column record type |
Return | osid.grading.GradebookColumnList | the returned GradebookColumn list | |
Errors | NULL_ARGUMENT | gradebookColumnRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumns | ||
Description |
Gets all gradebook columns. In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session. | ||
Return | osid.grading.GradebookColumnList | a GradebookColumn | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSummary | ||
Description |
Tests if a summary entry is available. | ||
Return | boolean | true if a summary entry is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnSummary | ||
Description |
Gets the | ||
Parameters | osid.id.Id | gradebookColumnId | Id of the GradebookColumn |
Return | osid.grading.GradebookColumnSummary | the gradebook column summary | |
Errors | NOT_FOUND | gradebookColumnId is not found | |
NULL_ARGUMENT | gradebookColumnId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNIMPLEMENTED | hasSummary() is false | ||
Compliance | mandatory | This method is must be implemented. |