Interface | osid.assessment.ItemAdminSession | ||
---|---|---|---|
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateItems | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Item creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateItemWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | itemRecordTypes | array of item record types |
Return | boolean | true if Item creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | itemRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemFormForCreate | ||
Description |
Gets the assessment item form for creating new assessment items. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | itemRecordTypes | array of item record types to be included in the create operation or an empty list if none |
Return | osid.assessment.ItemForm | the assessment item form | |
Errors | NULL_ARGUMENT | itemRecordTypes 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 | createItem | ||
Description |
Creates a new | ||
Parameters | osid.assessment.ItemForm | itemForm | the form for this Item |
Return | osid.assessment.Item | the new Item | |
Errors | ILLEGAL_STATE | itemForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | itemForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | itemForm did not originate from
getItemFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateItems | ||
Description |
Tests if this user can update | ||
Return | boolean | false if assessment item modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemFormForUpdate | ||
Description |
Gets the assessment item form for updating an existing item. A new item form should be requested for each update transaction. | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
Return | osid.assessment.ItemForm | the assessment item form | |
Errors | NOT_FOUND | itemId is not found | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateItem | ||
Description |
Updates an existing item. | ||
Parameters | osid.assessment.ItemForm | itemForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | itemForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | itemForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | itemForm did not originate from
getItemFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteItems | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Item deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteItem | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | itemId | the Id of the Item to delete |
Errors | NOT_FOUND | an Item was not found identified by the given Id
| |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageItemAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Item aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasItem | ||
Description |
Adds an | ||
Parameters | osid.id.Id | itemId | the Id of an Item |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | itemId not found | ||
NULL_ARGUMENT | itemId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQuestions | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Question creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQuestionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | questionRecordTypes | array of question record types |
Return | boolean | true if Question creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | questionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQuestionFormForCreate | ||
Description |
Gets the question form for creating new questions. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | itemId | an assessment item Id |
osid.type.Type[] | questionRecordTypes | array of question record types to be included in the create operation or an empty list if none | |
Return | osid.assessment.QuestionForm | the question form | |
Errors | NULL_ARGUMENT | questionRecordTypes 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 | createQuestion | ||
Description |
Creates a new | ||
Parameters | osid.assessment.QuestionForm | questionForm | the form for this Question |
Return | osid.assessment.Question | the new Question | |
Errors | ALREADY_EXISTS | a question already exists for this item | |
ILLEGAL_STATE | questionForm already used in a create transaction | ||
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | questionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | questionForm did not originate from
getQuestionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateQuestions | ||
Description |
Tests if this user can update | ||
Return | boolean | false if question modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQuestionFormForUpdate | ||
Description |
Gets the question form for updating an existing question. A new question form should be requested for each update transaction. | ||
Parameters | osid.id.Id | questionId | the Id of the Question |
Return | osid.assessment.QuestionForm | the question form | |
Errors | NOT_FOUND | questionId is not found | |
NULL_ARGUMENT | questionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQuestion | ||
Description |
Updates an existing question. | ||
Parameters | osid.assessment.QuestionForm | questionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | questionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | questionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | questionForm did not originate from
getQuestionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteQuestions | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Question deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteQuestion | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | questionId | the Id of the Question to delete |
Errors | NOT_FOUND | a Question was not found identified by the given Id
| |
NULL_ARGUMENT | questionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAnswers | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Answer creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAnswersWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | answerRecordTypes | array of answer record types |
Return | boolean | true if Answer creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | answernRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAnswerFormForCreate | ||
Description |
Gets the answer form for creating new answers. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | itemId | an assessment item Id |
osid.type.Type[] | answerRecordTypes | array of answer record types to be included in the create operation or an empty list if none | |
Return | osid.assessment.AnswerForm | the answer form | |
Errors | NULL_ARGUMENT | answerRecordTypes 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 | createAnswer | ||
Description |
Creates a new | ||
Parameters | osid.assessment.AnswerForm | answerForm | the form for this Answer |
Return | osid.assessment.Answer | the new Answer | |
Errors | ILLEGAL_STATE | answerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | answerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | answerForm did not originate from
getAnswerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAnswers | ||
Description |
Tests if this user can update | ||
Return | boolean | false if answer modification is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAnswerFormForUpdate | ||
Description |
Gets the answer form for updating an existing answer. A new answer form should be requested for each update transaction. | ||
Parameters | osid.id.Id | answerId | the Id of the Answer |
Return | osid.assessment.AnswerForm | the answer form | |
Errors | NOT_FOUND | answerId is not found | |
NULL_ARGUMENT | answerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAnswer | ||
Description |
Updates an existing answer. | ||
Parameters | osid.assessment.AnswerForm | answerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | answerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | answerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | answerForm did not originate from
getAnswerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAnswers | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Answer deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAnswer | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | answerId | the Id of the Answer to delete |
Errors | NOT_FOUND | an Answer was not found identified by the given Id
| |
NULL_ARGUMENT | answerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |