org.osid.checklist.batch

Interface TodoBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, TodoAdminSession

public interface TodoBatchAdminSession
extends TodoAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasTodos(AliasRequestList aliasRequests) Adds an Id to a Todo for the purpose of creating compatibility.
CreateResponseList	createTodos(TodoBatchFormList todoForms) Creates a new set of Todos.
DeleteResponseList	deleteAllTodos() Deletes all Todos in this Checklist .
DeleteResponseList	deleteIneffectiveCreditsByDate(DateTime date) Deletes todos expired before the given date.
DeleteResponseList	deleteTodos(IdList todoIds) Deletes todos for the given Ids.
DeleteResponseList	deleteTodosForResource(Id resourceId) Deletes todos for the given resource.
DeleteResponseList	deleteTodosForWork(Id workId) Deletes todos for the given work.
TodoBatchFormList	getTodoFormsForCreate(long number, Type[] todoRecordTypes) Gets the todo forms for creating a bunch of new todos.
TodoBatchFormList	getTodoFormsForUpdate(IdList todoIds) Gets the todo forms for updating an existing set of todos.
UpdateResponseList	updateTodos(TodoBatchFormList todoForms) Updates existing todos.

Methods inherited from interface org.osid.checklist.TodoAdminSession

addDependency, aliasTodo, canCreateTodos, canCreateTodoWithRecordTypes, canDeleteTodos, canManageDependencies, canManageTodoAliases, canUpdateTodos, createTodo, deleteTodo, getChecklist, getChecklistId, getTodoFormForCreate, getTodoFormForUpdate, removeDependency, updateTodo

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getTodoFormsForCreate

TodoBatchFormList getTodoFormsForCreate(long number,
                                      Type[] todoRecordTypes)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

todoRecordTypes - array of todo record types to be included in each create operation or an empty list if none

Returns:

the todo forms

Throws:

NullArgumentException - todoRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createTodos

CreateResponseList createTodos(TodoBatchFormList todoForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

todoForms - the todo forms

Returns:

the create responses

Throws:

NullArgumentException - todoForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodoFormsForUpdate

TodoBatchFormList getTodoFormsForUpdate(IdList todoIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

todoIds - the Ids of the Todo

Returns:

the todo form

Throws:

NotFoundException - a todoId is not found

NullArgumentException - todoIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateTodos

UpdateResponseList updateTodos(TodoBatchFormList todoForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

todoForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - todoForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllTodos

DeleteResponseList deleteAllTodos()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Todos in this Checklist .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteTodos

DeleteResponseList deleteTodos(IdList todoIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes todos for the given Ids.

Parameters:

todoIds - the Ids of the todos to delete

Returns:

the delete responses

Throws:

NullArgumentException - todoIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteTodosForResource

DeleteResponseList deleteTodosForResource(Id resourceId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes todos for the given resource.

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteTodosForWork

DeleteResponseList deleteTodosForWork(Id workId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes todos for the given work.

Parameters:

workId - the Id of a work

Returns:

the delete responses

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveCreditsByDate

DeleteResponseList deleteIneffectiveCreditsByDate(DateTime date)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes todos expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasTodos

AliasResponseList aliasTodos(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.