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.
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.
|
addDependency, aliasTodo, canCreateTodos, canCreateTodoWithRecordTypes, canDeleteTodos, canManageDependencies, canManageTodoAliases, canUpdateTodos, createTodo, deleteTodo, getChecklist, getChecklistId, getTodoFormForCreate, getTodoFormForUpdate, removeDependency, updateTodo
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
TodoBatchFormList getTodoFormsForCreate(long number, Type[] todoRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievetodoRecordTypes
- array of todo record types to be included in
each create operation or an empty list if noneNullArgumentException
- todoRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createTodos(TodoBatchFormList todoForms) throws OperationFailedException, PermissionDeniedException
Todos.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.todoForms
- the todo formsNullArgumentException
- todoForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TodoBatchFormList getTodoFormsForUpdate(IdList todoIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
todoIds
- the Ids
of the Todo
NotFoundException
- a todoId
is not
foundNullArgumentException
- todoIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateTodos(TodoBatchFormList todoForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.todoForms
- the form containing the elements to be updatedNullArgumentException
- todoForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllTodos() throws OperationFailedException, PermissionDeniedException
Todos
in this Checklist
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteTodos(IdList todoIds) throws OperationFailedException, PermissionDeniedException
Ids.
todoIds
- the Ids
of the todos to deleteNullArgumentException
- todoIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteTodosForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteTodosForWork(Id workId) throws OperationFailedException, PermissionDeniedException
workId
- the Id
of a workNullArgumentException
- workId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveCreditsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasTodos(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.