Interface | osid.grading.calculation.GradebookColumnCalculationAdminSession | ||
---|---|---|---|
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 | canCreateGradebookColumnCalculations | ||
Description |
Tests if this user can create gradebook column
calculationss. 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 GradebookColumnCalculation creation
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateGradebookColumnCalculationWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | gradebookColumnRecordCalculationTypes | array of gradebook column calculation record types |
Return | boolean | true if GradebookColumnCalculation creation
using the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | gradebookColumnRecordCalculationTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnCalculationFormForCreate | ||
Description |
Gets the gradebook column calculation form for creating new gradebook columns. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | gradebookColumnId | the Id for the GradebookColumn |
osid.type.Type[] | gradebookColumnRecordCalculationTypes | array of gradebook column calculation record types | |
Return | osid.grading.calculation.GradebookColumnCalculationForm | the gradebook column calculation form | |
Errors | ALREADY_EXISTS | gradebookColumnId already has a calculation | |
NOT_FOUND | gradebookColumnId is not found | ||
NULL_ARGUMENT | gradebokColumnId or
gradebookColumnRecordCalculationTypes 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 | createGradebookColumnCalculation | ||
Description |
Creates a new | ||
Parameters | osid.grading.calculation.GradebookColumnCalculationForm | gradebookColumnCalculationForm | the form containing the elements to be updated |
Return | osid.grading.calculation.GradebookColumnCalculation | the new GradebookColumnCalculation | |
Errors | ILLEGAL_STATE | gradebookColumnCalculationForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | gradebookColumnCalculationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradebookColumnCalculationForm did not originate from
getGradebookColumnCalculationFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateGradebookColumnCalculations | ||
Description |
Tests if this user can update gradebook column
calculations. 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 calculation modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnCalculationFormForUpdate | ||
Description |
Gets the gradebook column calculation form for updating an existing gradebook column. A new gradebook column form should be requested for each update transaction. | ||
Parameters | osid.id.Id | gradebookColumnCalculationId | the Id of the GradebookColumnCalculation |
Return | osid.grading.calculation.GradebookColumnCalculationForm | the gradebook column calculation form | |
Errors | NOT_FOUND | gradebookColumnCalculationId is not found | |
NULL_ARGUMENT | gradebookColumnCalculationId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateGradebookColumnCalculation | ||
Description |
Updates an existing gradebook column calculation. | ||
Parameters | osid.grading.calculation.GradebookColumnCalculationForm | gradebookColumnCalculationForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | gradebookColumnCalculationForm already used in a update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | gradebookColumnCalculationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradebookColumnCalculationForm did not originate from
getGradebookColumnCalculationFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteGradebookColumnCalculations | ||
Description |
Tests if this user can delete gradebook column
calculations. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known deleting a | ||
Return | boolean | false if GradebookColumnCalculation deletion
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteGradebookColumnCalculation | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | gradebookColumnCalculationId | the Id of the GradebookColumnCalculation to
delete |
Errors | NOT_FOUND | a GradebookColumnCalculation was not found identified by the
given Id | |
NULL_ARGUMENT | gradebookColumnCalculationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |