OSID Logo
OSID Specifications
checklist batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.batch.TodoBatchAdminSession
Implementsosid.checklist.TodoAdminSession
Description

This session creates, updates, and deletes Todos in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Todo, a TodoForm is requested using getTodoFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned TodoForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a TodoForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each TodoForm corresponds to an attempted transaction.

The TodoForms returned from getTodoFormsForCreate() may be linked to the originating request through the peer Ids of the TodoForm. In the case where there may be duplicates, any TodoForm of the same peer Ids may be used for a create operation.

Once a batch of TodoForms are submitted for create, a CreateResponse is returned for each TodoForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createTodos(), errors specific to an individual TodoForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating TodoForm through the TodoForm Id .

For updates, TodoForms are requested to the Todo Id that is to be updated using getTodoFormsForUpdate() where the reference Id in the TodoForm may be used to link the request. Similarly, the TodoForm has metadata about the data that can be updated and it can perform validation before submitting the update. The TodoForm can only be used once for a successful update and cannot be reused.

Once a batch of TodoForms are submitted for update, an UpdateResponse is returned for each TodoForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateTodos(), errors specific to an individual TodoForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating TodoForm through the TodoForm Id.

The delete operations delete Todos in bulk. To unmap a Todo from the current Checklist, the TodoChecklistAssignmentSession should be used. These delete operations attempt to remove the Todo itself thus removing it from all known Checklist catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetTodoFormsForCreate
Description

Gets the todo forms for creating a bunch of new todos.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]todoRecordTypesarray of todo record types to be included in each create operation or an empty list if none
Returnosid.checklist.batch.TodoBatchFormListthe todo forms
ErrorsNULL_ARGUMENT todoRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateTodos
Description

Creates a new set of Todos. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.checklist.batch.TodoBatchFormListtodoFormsthe todo forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT todoForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodoFormsForUpdate
Description

Gets the todo forms for updating an existing set of todos. A new todo form should be requested for each update transaction.

Parametersosid.id.IdListtodoIdsthe Ids of the Todo
Returnosid.checklist.batch.TodoBatchFormListthe todo form
ErrorsNOT_FOUNDa todoId is not found
NULL_ARGUMENT todoIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateTodos
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 BatchCreateResponse .

Parametersosid.checklist.batch.TodoBatchFormListtodoFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT todoForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllTodos
Description

Deletes all Todos in this Checklist .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteTodos
Description

Deletes todos for the given Ids.

Parametersosid.id.IdListtodoIdsthe Ids of the todos to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT todoIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteTodosForResource
Description

Deletes todos for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteTodosForWork
Description

Deletes todos for the given work.

Parametersosid.id.IdworkIdthe Id of a work
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveCreditsByDate
Description

Deletes todos expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasTodos
Description

Adds an Id to a Todo for the purpose of creating compatibility. The primary Id of the Todo is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another todo, it is reassigned to the given entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.