public interface ChecklistBatchAdminSession extends ChecklistAdminSession
This session creates, updates, and deletes Checklists
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 an
Checklist,
an ChecklistForm
is requested
using getChecklistFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned ChecklistForms
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 an ChecklistForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
ChecklistForm
corresponds to an attempted transaction.
The ChecklistForms
returned from
getChecklistFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ChecklistForm.
In the case where there may be duplicates, any
ChecklistForm
of the same peer Ids
may be used for
a create operation.
Once a batch of ChecklistForms
are submitted for
create, a CreateResponse
is returned for each
ChecklistForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createChecklists(),
errors specific to an individual
ChecklistForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating ChecklistForm
through the
ChecklistForm
Id
.
For updates, ChecklistForms
are requested to the
Checklist
Id
that is to be updated using
getChecklistFormsForUpdate()
where the reference Id
in the ChecklistForm
may be used to link the request.
Similarly, the ChecklistForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The ChecklistForm
can only be used once for a
successful update and cannot be reused.
Once a batch of ChecklistForms
are submitted for
update, an UpdateResponse
is returned for each
ChecklistForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateChecklists(),
errors specific to an individual
ChecklistForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating ChecklistForm
through the
ChecklistForm
Id.
The delete operations delete Checklists
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasChecklists(AliasRequestList aliasRequests)
Adds an
Id to an Checklist for the
purpose of creating compatibility. |
CreateResponseList |
createChecklists(ChecklistBatchFormList checklistForms)
Creates a new set of
Checklists. |
DeleteResponseList |
deleteAllChecklists()
Deletes all
Checklists. |
DeleteResponseList |
deleteChecklists(IdList checklistIds)
Deletes checklists for the given
Ids. |
ChecklistBatchFormList |
getChecklistFormsForCreate(long number,
Type[] checklistRecordTypes)
Gets the checklist forms for creating a bunch of new checklists.
|
ChecklistBatchFormList |
getChecklistFormsForUpdate(IdList checklistIds)
Gets the checklist forms for updating an existing set of checklists.
|
UpdateResponseList |
updateChecklists(ChecklistBatchFormList checklistForms)
Updates existing checklists.
|
aliasChecklist, canCreateChecklists, canCreateChecklistWithRecordTypes, canDeleteChecklists, canManageChecklistAliases, canUpdateChecklists, createChecklist, deleteChecklist, getChecklistFormForCreate, getChecklistFormForUpdate, updateChecklist
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ChecklistBatchFormList getChecklistFormsForCreate(long number, Type[] checklistRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievechecklistRecordTypes
- array of checklist record types to be
included in each create operation or an empty list if noneNullArgumentException
- checklistRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createChecklists(ChecklistBatchFormList checklistForms) throws OperationFailedException, PermissionDeniedException
Checklists.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.checklistForms
- the checklist formsNullArgumentException
- checklistForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChecklistBatchFormList getChecklistFormsForUpdate(IdList checklistIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
checklistIds
- the Ids
of the Checklist
NotFoundException
- an checklistId
is
not foundNullArgumentException
- checklistIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateChecklists(ChecklistBatchFormList checklistForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.checklistForms
- the form containing the elements to be updatedNullArgumentException
- checklistForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllChecklists() throws OperationFailedException, PermissionDeniedException
Checklists.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteChecklists(IdList checklistIds) throws OperationFailedException, PermissionDeniedException
Ids.
checklistIds
- the Ids
of the checklists to
deleteNullArgumentException
- checklistIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasChecklists(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Checklist
for the
purpose of creating compatibility. The primary Id
of
the Checklist
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another checklist, 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.