Interface | osid.grading.GradeSystemAdminSession | ||
---|---|---|---|
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 | canCreateGradeSystems | ||
Description |
Tests if this user can create | ||
Return | boolean | false if GradeSystem creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateGradeSystemWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | gradeSystemRecordTypes | array of grade system types |
Return | boolean | true if GradeSystem creation using the
specified Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | gradeSystemRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeSystemFormForCreate | ||
Description |
Gets the grade system form for creating new grade systems. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | gradeSystemRecordTypes | array of grade system types |
Return | osid.grading.GradeSystemForm | the grade system form | |
Errors | NULL_ARGUMENT | gradeSystemRecordTypes 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 | createGradeSystem | ||
Description |
Creates a new | ||
Parameters | osid.grading.GradeSystemForm | gradeSystemForm | the form for this GradeSystem |
Return | osid.grading.GradeSystem | the new GradeSystem | |
Errors | ILLEGAL_STATE | gradeSystemForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | gradeSystemForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeSystemForm did not originate from
getGradeSystemFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateGradeSystems | ||
Description |
Tests if this user can update | ||
Return | boolean | false if GradeSystem modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeSystemFormForUpdate | ||
Description |
Gets the grade system form for updating an existing grade system. A new grade system form should be requested for each update transaction. | ||
Parameters | osid.id.Id | gradeSystemId | the Id of the GradeSystem |
Return | osid.grading.GradeSystemForm | the grade system form | |
Errors | NOT_FOUND | gradeSystemId is not found | |
NULL_ARGUMENT | gradeSystemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateGradeSystem | ||
Description |
Updates an existing grade system. | ||
Parameters | osid.grading.GradeSystemForm | gradeSystemForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | gradeSystemForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | gradeSystemForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeSystemForm did not originate from
getGradeSystemFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteGradeSystems | ||
Description |
Tests if this user can delete grade systems. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if GradeSystem deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteGradeSystem | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | gradeSystemId | the Id of the GradeSystem to remove |
Errors | NOT_FOUND | gradeSystemId not found | |
NULL_ARGUMENT | gradeSystemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageGradeSystemAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if GradeSystem aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasGradeSystem | ||
Description |
Adds an | ||
Parameters | osid.id.Id | gradeSystemId | the Id of a GradeSystem |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | gradeSystemId not found | ||
NULL_ARGUMENT | gradeSystemId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateGrades | ||
Description |
Tests if this user can create | ||
Parameters | osid.id.Id | gradeSystemId | the Id of a GradeSystem |
Return | boolean | false if Grade creation is not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateGradeWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.id.Id | gradeSystemId | the Id of a GradeSystem |
osid.type.Type[] | gradeRecordTypes | array of grade recod types | |
Return | boolean | true if Grade creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | gradeSystemId or gradeRecordTypes is
null | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeFormForCreate | ||
Description |
Gets the grade form for creating new grades. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | gradeSystemId | the Id of a GradeSystem |
osid.type.Type[] | gradeRecordTypes | array of grade recod types | |
Return | osid.grading.GradeForm | the grade form | |
Errors | NOT_FOUND | gradeSystemId is not found | |
NULL_ARGUMENT | gradeSystemId or gradeRecordTypes 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 | createGrade | ||
Description |
Creates a new | ||
Parameters | osid.grading.GradeForm | gradeForm | the form for this Grade |
Return | osid.grading.Grade | the new Grade | |
Errors | ILLEGAL_STATE | gradeForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | gradeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeForm did not originate from
getGradeFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateGrades | ||
Description |
Tests if this user can update | ||
Parameters | osid.id.Id | gradeSystemId | the Id of a GradeSystem |
Return | boolean | false if Grade modification is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeFormForUpdate | ||
Description |
Gets the grade form for updating an existing grade. A new grade form should be requested for each update transaction. | ||
Parameters | osid.id.Id | gradeId | the Id of the Grade |
Return | osid.grading.GradeForm | the grade form | |
Errors | NOT_FOUND | gradeId is not found | |
NULL_ARGUMENT | gradeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateGrade | ||
Description |
Updates an existing grade. | ||
Parameters | osid.grading.GradeForm | gradeForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | gradeForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | gradeId or gradeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeForm did not originate from
getGradeFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteGrades | ||
Description |
Tests if this user can delete grades. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting a | ||
Parameters | osid.id.Id | gradeSystemId | the Id of a GradeSystem |
Return | boolean | false if Grade deletion is not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteGrade | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | gradeId | the Id of the Grade to remove |
Errors | NOT_FOUND | gradeId not found | |
NULL_ARGUMENT | gradeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageGradeAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Grade aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasGrade | ||
Description |
Adds an | ||
Parameters | osid.id.Id | gradeId | the Id of a Grade |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | gradeId not found | ||
NULL_ARGUMENT | gradeId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |