public interface InquestBatchAdminSession extends InquestAdminSession
This session creates, updates, and deletes Inquests
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
Inquest,
an InquestForm
is requested using
getInquestFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned InquestForms
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 InquestForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
InquestForm
corresponds to an attempted transaction.
The InquestForms
returned from
getInquestFormsForCreate()
may be linked to the originating
request through the peer Ids
of the InquestForm.
In the case where there may be duplicates, any InquestForm
of the same peer Ids
may be used for a create
operation.
Once a batch of InquestForms
are submitted for create,
a CreateResponse
is returned for each InquestForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createInquest(),
errors specific to an individual InquestForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
InquestForm
through the InquestForm
Id
.
For updates, InquestForms
are requested to the
InquestForm
Id
that is to be updated using
getInquestFormsForUpdate()
where the reference Id
in the InquestForm
may be used to link the request.
Similarly, the InquestForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The InquestForm
can only be used once for a successful
update and cannot be reused.
Once a batch of InquestForms
are submitted for update,
an UpdateResponse
is returned for each InquestForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateInquest(),
errors specific to an individual InquestForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
InquestForm
through the InquestForm
Id.
The delete operations delete Inquests
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasInquests(AliasRequestList aliasRequests)
Adds an
Id to an Inquest for the purpose
of creating compatibility. |
CreateResponseList |
createInquests(InquestBatchFormList inquestForms)
Creates a new set of
Inquests. |
DeleteResponseList |
deleteAllInquests()
Deletes all
Inquests. |
DeleteResponseList |
deleteInquests(IdList inquestIds)
Deletes inquests for the given
Ids. |
InquestBatchFormList |
getInquestFormsForCreate(long number,
Type[] inquestRecordTypes)
Gets the inquest forms for creating a bunch of new inquests.
|
InquestBatchFormList |
getInquestFormsForUpdate(IdList inquestIds)
Gets the inquest forms for updating an existing set of inquests.
|
UpdateResponseList |
updateInquests(InquestBatchFormList inquestForms)
Updates existing inquests.
|
aliasInquest, canCreateInquests, canCreateInquestWithRecordTypes, canDeleteInquests, canManageInquestAliases, canUpdateInquests, createInquest, deleteInquest, getInquestFormForCreate, getInquestFormForUpdate, updateInquest
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InquestBatchFormList getInquestFormsForCreate(long number, Type[] inquestRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveinquestRecordTypes
- array of inquest record types to be
included in each create operation or an empty list if noneNullArgumentException
- inquestRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createInquests(InquestBatchFormList inquestForms) throws OperationFailedException, PermissionDeniedException
Inquests.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.inquestForms
- the inquest formsNullArgumentException
- inquestForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestBatchFormList getInquestFormsForUpdate(IdList inquestIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquestIds
- the Ids
of the Inquests
NotFoundException
- an inquestId
is not
foundNullArgumentException
- inquestIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateInquests(InquestBatchFormList inquestForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.inquestForms
- the form containing the elements to be updatedNullArgumentException
- inquestForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllInquests() throws OperationFailedException, PermissionDeniedException
Inquests.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
Ids.
inquestIds
- the Ids
of the inquests to deleteNullArgumentException
- inquestIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasInquests(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Inquest
for the purpose
of creating compatibility. The primary Id
of the
Inquest
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another inquest, it is reassigned to the given inquest
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.