Interface | osid.grading.GradebookColumnAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateGradebookColumns | ||
Description |
Tests if this user can create gradebook columns. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a gradebook column will result in a | ||
Return | boolean | false if GradebookColumn creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateGradebookColumnWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | gradebookColumnRecordTypes | array of gradebook column record types |
Return | boolean | true if GradebookColumn creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | gradebookColumnRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnFormForCreate | ||
Description |
Gets the gradebook column form for creating new gradebook columns. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | gradebookColumnRecordTypes | array of gradebook column record types |
Return | osid.grading.GradebookColumnForm | the gradebook column form | |
Errors | NULL_ARGUMENT | gradebookColumnRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createGradebookColumn | ||
Description |
Creates a new | ||
Parameters | osid.grading.GradebookColumnForm | gradebookColumnForm | the form for this GradebookColumn |
Return | osid.grading.GradebookColumn | the new GradebookColumn | |
Errors | ILLEGAL_STATE | gradebookColumnForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | gradebookColumnForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradebookColumnForm did not originate from
getGradebookColumnFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateGradebookColumns | ||
Description |
Tests if this user can update gradebook columns. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if gradebook column modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnFormForUpdate | ||
Description |
Gets the gradebook column form for updating an existing gradebook column. A new gradebook column form should be requested for each update transaction. | ||
Parameters | osid.id.Id | gradebookColumnId | the Id of the GradebookColumn |
Return | osid.grading.GradebookColumnForm | the gradebook column form | |
Errors | NOT_FOUND | gradebookColumnId is not found | |
NULL_ARGUMENT | gradebookColumnId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateGradebookColumn | ||
Description |
Updates an existing gradebook column. | ||
Parameters | osid.grading.GradebookColumnForm | gradebookColumnForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | gradebookColumnForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | gradebookColumnForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradebookColumnForm did not originate from
getGradebookColumnFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | sequenceGradebookColumns | ||
Description |
Resequences the gradebook columns. | ||
Parameters | osid.id.IdList | gradebookColumnIds | the Ids of the GradebookColumns |
Errors | NULL_ARGUMENT | gradebookColumnIdList is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveGradebookColumn | ||
Description |
Moves a gradebook column in front of another. | ||
Parameters | osid.id.Id | frontGradebookColumnId | the Id of a GradebookColumn |
osid.id.Id | backGradebookColumnId | the Id of a GradebookColumn | |
Errors | NOT_FOUND | frontGradebookColumnId or backGradebookColumnId is not found | |
NULL_ARGUMENT | frontGradebookColumnId or backGradebookColumnId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | copyGradebookColumnEntries | ||
Description |
Copies gradebook column entries from one column to another. If the target grade column grade system differs from the source, the grades in the entries are transformed to the new grade system. | ||
Parameters | osid.id.Id | sourceGradebookColumnId | the Id of a GradebookColumn |
osid.id.Id | targetGradebookColumnId | the Id of a GradebookColumn | |
Errors | NOT_FOUND | sourceGradebookColumnId ortargetGradebookColumnId is not
found | |
NULL_ARGUMENT | sourceGradebookColumnId targetGradebookColumnId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteGradebookColumns | ||
Description |
Tests if this user can delete gradebook columns. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if GradebookColumn deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteGradebookColumn | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | gradebookColumnId | the Id of the GradebookColumn to delete |
Errors | NOT_FOUND | a GradebookColumn was not found identified by the given
Id | |
NULL_ARGUMENT | gradebookColumnId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageGradebookColumnAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if GradebookColumn aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasGradebookColumn | ||
Description |
Adds an | ||
Parameters | osid.id.Id | gradebookColumnId | the Id of a GradebookColumn |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | gradebookColumnId not found | ||
NULL_ARGUMENT | gradebookColumnId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |