Interface | osid.grading.GradeEntryAdminSession | ||
---|---|---|---|
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 | canCreateGradeEntries | ||
Description |
Tests if this user can create grade entries. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
grade entry will result in a | ||
Return | boolean | false if GradeEntry creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateGradeEntryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | gradeEntryRecordTypes | array of grade entry record types |
Return | boolean | true if GradeEntry creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | gradeEntryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeEntryFormForCreate | ||
Description |
Gets the grade entry form for creating new grade entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | gradebookColumnId | the gradebook column |
osid.id.Id | resourceId | the key resource | |
osid.type.Type[] | gradeEntryRecordTypes | array of grade entry record types | |
Return | osid.grading.GradeEntryForm | the grade entry form | |
Errors | NOT_FOUND | gradebookColumnId or resourceId not found | |
NULL_ARGUMENT | gradebookColumnId, resourceId, or
gradeEntryRecordTypes 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 | createGradeEntry | ||
Description |
Creates a new | ||
Parameters | osid.grading.GradeEntryForm | gradeEntryForm | the form for this GradeEntry |
Return | osid.grading.GradeEntry | the new GradeEntry | |
Errors | ILLEGAL_STATE | gradeEntryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | gradeEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeEntryForm did not originate from
getGradeEntryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canOverridecalculatedGradeEntries | ||
Description |
Tests if this user can override grade entries
calculated from another. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known creating a grade entry will
result in a | ||
Return | boolean | false if GradeEntry override is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeEntryFormForOverride | ||
Description |
Gets the grade entry form for overriding calculated grade entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | gradeEntryId | the Id of the grade entry to be overridden |
osid.type.Type[] | gradeEntryRecordTypes | array of grade entry record types | |
Return | osid.grading.GradeEntryForm | the grade entry form | |
Errors | ALREADY_EXISTS | gradeEntryId is already overridden | |
NOT_FOUND | gradeEntryId not found or gradeEntryId is not
a calculated entry | ||
NULL_ARGUMENT | gradeEntryId or gradeEntryRecordTypes 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 | overrideCalculatedGradeEntry | ||
Description |
Creates a new overriding | ||
Parameters | osid.grading.GradeEntryForm | gradeEntryForm | the form for this GradeEntry |
Return | osid.grading.GradeEntry | the new GradeEntry | |
Errors | ILLEGAL_STATE | gradeEntryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | gradeEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeEntryForm did not originate from
getGradeEntryFormForOverride() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateGradeEntries | ||
Description |
Tests if this user can update grade entries. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating a
| ||
Return | boolean | false if grade entry modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeEntryFormForUpdate | ||
Description |
Gets the grade entry form for updating an existing entry. A new grade entry form should be requested for each update transaction. | ||
Parameters | osid.id.Id | gradeEntryId | the Id of the GradeEntry |
Return | osid.grading.GradeEntryForm | the grade entry form | |
Errors | NOT_FOUND | gradeEntryId is not found | |
NULL_ARGUMENT | gradeEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateGradeEntry | ||
Description |
Updates an existing grade entry. | ||
Parameters | osid.grading.GradeEntryForm | gradeEntryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | gradeEntryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | gradeEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | gradeEntryForm did not originate from
getGradeEntryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteGradeEntries | ||
Description |
Tests if this user can delete grade entries. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if GradeEntry deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteGradeEntry | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | gradeEntryId | the Id of the GradeEntry to delete |
Errors | NOT_FOUND | a GradeEntry was not found identified by the given Id
| |
NULL_ARGUMENT | gradeEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageGradeEntryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if GradeEntry aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasGradeEntry | ||
Description |
Adds an | ||
Parameters | osid.id.Id | gradeEntryId | the Id of a GradeEntry |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | gradeEntryId not found | ||
NULL_ARGUMENT | gradeEntryId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |