Interface | osid.checklist.batch.ChecklistBatchAdminSession | ||
---|---|---|---|
Implements | osid.checklist.ChecklistAdminSession | ||
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 | getChecklistFormsForCreate | ||
Description |
Gets the checklist forms for creating a bunch of new checklists. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | checklistRecordTypes | array of checklist record types to be included in each create operation or an empty list if none | |
Return | osid.checklist.batch.ChecklistBatchFormList | the checklist forms | |
Errors | NULL_ARGUMENT | checklistRecordTypes 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 | createChecklists | ||
Description |
Creates a new set of | ||
Parameters | osid.checklist.batch.ChecklistBatchFormList | checklistForms | the checklist forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | checklistForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistFormsForUpdate | ||
Description |
Gets the checklist forms for updating an existing set of checklists. A new checklist form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | checklistIds | the Ids of the Checklist |
Return | osid.checklist.batch.ChecklistBatchFormList | the checklist form | |
Errors | NOT_FOUND | an checklistId is not found | |
NULL_ARGUMENT | checklistIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateChecklists | ||
Description |
Updates existing checklists. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.checklist.batch.ChecklistBatchFormList | checklistForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | checklistForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllChecklists | ||
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 | deleteChecklists | ||
Description |
Deletes checklists for the given | ||
Parameters | osid.id.IdList | checklistIds | the Ids of the checklists to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | checklistIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasChecklists | ||
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. |