Interface | osid.assessment.AssessmentAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBank | ||
Description |
Gets the | ||
Return | osid.assessment.Bank | the Bank associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAssessments | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Assessment creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAssessmentWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | assessmentRecordTypes | array of assessment record types |
Return | boolean | true if Assessment creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | assessmentRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentFormForCreate | ||
Description |
Gets the assessment form for creating new assessments. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | assessmentRecordTypes | array of assessment record types to be included in the create operation or an empty list if none |
Return | osid.assessment.AssessmentForm | the assessment form | |
Errors | NULL_ARGUMENT | assessmentRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAssessment | ||
Description |
Creates a new | ||
Parameters | osid.assessment.AssessmentForm | assessmentForm | the form for this Assessment |
Return | osid.assessment.Assessment | the new Assessment | |
Errors | ILLEGAL_STATE | assessmentForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | assessmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | assessmentForm did not originate from
getAssessmentFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAssessments | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Assessment modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentFormForUpdate | ||
Description |
Gets the assessment form for updating an existing assessment. A new assessment form should be requested for each update transaction. | ||
Parameters | osid.id.Id | assessmentId | the Id of the Assessment |
Return | osid.assessment.AssessmentForm | the assessment form | |
Errors | NOT_FOUND | assessmentId is not found | |
NULL_ARGUMENT | assessmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAssessment | ||
Description |
Updates an existing assessment. | ||
Parameters | osid.assessment.AssessmentForm | assessmentForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | assessmentForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | assessmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | assessmentForm did not originate from getAssessmentFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAssessments | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Assessment deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAssessment | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | assessmentId | the Id of the Assessment to remove |
Errors | NOT_FOUND | assessmentId not found | |
NULL_ARGUMENT | assessmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAssessmentAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Assessment aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAssessment | ||
Description |
Adds an | ||
Parameters | osid.id.Id | assessmentId | the Id of an Assessment |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | assessmentId not found | ||
NULL_ARGUMENT | assessmentId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |