Interface | osid.assessment.batch.ItemBatchAdminSession | ||
---|---|---|---|
Implements | osid.assessment.ItemAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getItemFormsForCreate | ||
Description |
Gets the item forms for creating a bunch of new items. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | itemRecordTypes | array of item record types to be included in each create operation or an empty list if none | |
Return | osid.assessment.batch.ItemBatchFormList | the item forms | |
Errors | NULL_ARGUMENT | itemRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createItems | ||
Description |
Creates a new set of | ||
Parameters | osid.assessment.batch.ItemBatchFormList | itemForms | the item forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | itemForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemFormsForUpdate | ||
Description |
Gets the item forms for updating an existing set of items. A new item form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | itemIds | the Ids of the Items |
Return | osid.assessment.batch.ItemBatchFormList | the item forms | |
Errors | NOT_FOUND | an itemId is not found | |
NULL_ARGUMENT | itemIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateItems | ||
Description |
Updates existing items. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.assessment.batch.ItemBatchFormList | itemForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | itemForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllItems | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteItems | ||
Description |
Deletes items for the given | ||
Parameters | osid.id.IdList | itemIds | the Ids of the items to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | itemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasItems | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQuestionFormsForCreate | ||
Description |
Gets the question forms for creating a bunch of new
questions. A new form is retrieved for each supplied item
| ||
Parameters | osid.id.IdList | itemIds | a list of item Ids |
osid.type.Type[] | questionRecordTypes | array of question record types to be included in each create operation or an empty list if none | |
Return | osid.assessment.batch.QuestionBatchFormList | the question forms | |
Errors | NOT_FOUND | an itemId is not found | |
NULL_ARGUMENT | itemIds or questionRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createQuestions | ||
Description |
Creates a new set of | ||
Parameters | osid.assessment.batch.QuestionBatchFormList | questionForms | the question forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | questionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQuestionFormsForUpdate | ||
Description |
Gets the question forms for updating an existing set of questions. A new question form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | questionIds | the Ids of the Questions |
Return | osid.assessment.batch.QuestionBatchFormList | the question forms | |
Errors | NOT_FOUND | a questionId is not found | |
NULL_ARGUMENT | questionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQuestions | ||
Description |
Updates existing questions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.assessment.batch.QuestionBatchFormList | questionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | questionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllQuestions | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteQuestions | ||
Description |
Deletes questions for the given | ||
Parameters | osid.id.IdList | questionIds | the Ids of the questions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | questionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAnswerFormsForCreate | ||
Description |
Gets the answer forms for creating a bunch of new
answers. A new form is retrieved for each supplied item
| ||
Parameters | osid.id.IdList | itemIds | a list of item Ids |
osid.type.Type[] | answerRecordTypes | array of answer record types to be included in each create operation or an empty list if none | |
Return | osid.assessment.batch.AnswerBatchFormList | the answer forms | |
Errors | NOT_FOUND | an itemId is not found | |
NULL_ARGUMENT | itemIds or answerRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAnswers | ||
Description |
Creates a new set of | ||
Parameters | osid.assessment.batch.AnswerBatchFormList | answersForms | the answer forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | answerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAnswerFormsForUpdate | ||
Description |
Gets the answers forms for updating an existing set of answers. A new answer form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | answersIds | the Ids of the Answers |
Return | osid.assessment.batch.AnswerBatchFormList | the answer forms | |
Errors | NOT_FOUND | an answerId is not found | |
NULL_ARGUMENT | answerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAnswers | ||
Description |
Updates existing answers. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.assessment.batch.AnswerBatchFormList | answersForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | answerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAnswers | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAnswers | ||
Description |
Deletes answers for the given | ||
Parameters | osid.id.IdList | answersIds | the Ids of the answers to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | answerIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |