Interface | osid.checklist.batch.TodoBatchAdminSession | ||
---|---|---|---|
Implements | osid.checklist.TodoAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getTodoFormsForCreate | ||
Description |
Gets the todo forms for creating a bunch of new todos. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | todoRecordTypes | array of todo record types to be included in each create operation or an empty list if none | |
Return | osid.checklist.batch.TodoBatchFormList | the todo forms | |
Errors | NULL_ARGUMENT | todoRecordTypes 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 | createTodos | ||
Description |
Creates a new set of | ||
Parameters | osid.checklist.batch.TodoBatchFormList | todoForms | the todo forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | todoForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoFormsForUpdate | ||
Description |
Gets the todo forms for updating an existing set of todos. A new todo form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | todoIds | the Ids of the Todo |
Return | osid.checklist.batch.TodoBatchFormList | the todo form | |
Errors | NOT_FOUND | a todoId is not found | |
NULL_ARGUMENT | todoIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateTodos | ||
Description |
Updates existing todos. 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.TodoBatchFormList | todoForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | todoForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllTodos | ||
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 | deleteTodos | ||
Description |
Deletes todos for the given | ||
Parameters | osid.id.IdList | todoIds | the Ids of the todos to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | todoIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteTodosForResource | ||
Description |
Deletes todos for the given resource. | ||
Parameters | osid.id.Id | resourceId | the Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteTodosForWork | ||
Description |
Deletes todos for the given work. | ||
Parameters | osid.id.Id | workId | the Id of a work |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveCreditsByDate | ||
Description |
Deletes todos expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasTodos | ||
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. |