public interface VaultBatchAdminSession extends VaultAdminSession
This session creates, updates, and deletes Vaults
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
Vault,
an VaultForm
is requested using
getVaultFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed.
Each of the returned VaultForms
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 VaultForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
VaultForm
corresponds to an attempted transaction.
The VaultForms
returned from
getVaultFormsForCreate()
may be linked to the originating request
through the peer Ids
of the VaultForm.
In
the case where there may be duplicates, any VaultForm
of
the same peer Ids
may be used for a create operation.
Once a batch of VaultForms
are submitted for create, a
CreateResponse
is returned for each VaultForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createVaults(),
errors specific to an individual VaultForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating VaultForm
through the VaultForm
Id
.
For updates, VaultForms
are requested to the
Vault
Id
that is to be updated using
getVaultFormsForUpdate()
where the reference Id
in
the VaultForm
may be used to link the request. Similarly,
the VaultForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
VaultForm
can only be used once for a successful update and
cannot be reused.
Once a batch of VaultForms
are submitted for update, an
UpdateResponse
is returned for each VaultForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateVaults(),
errors specific to an individual VaultForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating VaultForm
through the VaultForm
Id.
The delete operations delete Vaults
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasVaults(AliasRequestList aliasRequests)
Adds an
Id to an Vault for the purpose
of creating compatibility. |
CreateResponseList |
createVaults(VaultBatchFormList vaultForms)
Creates a new set of
Vaults. |
DeleteResponseList |
deleteAllVaults()
Deletes all
Vaults. |
DeleteResponseList |
deleteVaults(IdList vaultIds)
Deletes vaults for the given
Ids. |
VaultBatchFormList |
getVaultFormsForCreate(long number,
Type[] vaultRecordTypes)
Gets the vault forms for creating a bunch of new vaults.
|
VaultBatchFormList |
getVaultFormsForUpdate(IdList vaultIds)
Gets the vault forms for updating an existing set of vaults.
|
UpdateResponseList |
updateVaults(VaultBatchFormList vaultForms)
Updates existing vaults.
|
aliasVault, canCreateVaults, canCreateVaultWithRecordTypes, canDeleteVaults, canManageVaultAliases, canUpdateVaults, createVault, deleteVault, getVaultFormForCreate, getVaultFormForUpdate, updateVault
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
VaultBatchFormList getVaultFormsForCreate(long number, Type[] vaultRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievevaultRecordTypes
- array of vault record types to be included in
each create operation or an empty list if noneNullArgumentException
- vaultRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createVaults(VaultBatchFormList vaultForms) throws OperationFailedException, PermissionDeniedException
Vaults.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.vaultForms
- the vault formsNullArgumentException
- vaultForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. VaultBatchFormList getVaultFormsForUpdate(IdList vaultIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
vaultIds
- the Ids
of the Vault
NotFoundException
- an vaultId
is not
foundNullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateVaults(VaultBatchFormList vaultForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.vaultForms
- the form containing the elements to be updatedNullArgumentException
- vaultForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllVaults() throws OperationFailedException, PermissionDeniedException
Vaults.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Ids.
vaultIds
- the Ids
of the vaults to deleteNullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasVaults(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Vault
for the purpose
of creating compatibility. The primary Id
of the
Vault
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another vault, 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.