org.osid.authorization.batch

Interface VaultBatchAdminSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.authorization.VaultAdminSession

aliasVault, canCreateVaults, canCreateVaultWithRecordTypes, canDeleteVaults, canManageVaultAliases, canUpdateVaults, createVault, deleteVault, getVaultFormForCreate, getVaultFormForUpdate, updateVault

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

getVaultFormsForCreate

VaultBatchFormList getVaultFormsForCreate(long number,
                                        Type[] vaultRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the vault forms for creating a bunch of new vaults.

Parameters:

number - the number of forms to retrieve

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

Returns:

the vault forms

Throws:

NullArgumentException - vaultRecordTypes 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.

createVaults

CreateResponseList createVaults(VaultBatchFormList vaultForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Creates a new set of Vaults. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

vaultForms - the vault forms

Returns:

the create responses

Throws:

NullArgumentException - vaultForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultFormsForUpdate

VaultBatchFormList getVaultFormsForUpdate(IdList vaultIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

vaultIds - the Ids of the Vault

Returns:

the vault form

Throws:

NotFoundException - an vaultId is not found

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateVaults

UpdateResponseList updateVaults(VaultBatchFormList vaultForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates existing vaults. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

vaultForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - vaultForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllVaults

DeleteResponseList deleteAllVaults()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Vaults.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteVaults

DeleteResponseList deleteVaults(IdList vaultIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes vaults for the given Ids.

Parameters:

vaultIds - the Ids of the vaults to delete

Returns:

the delete responses

Throws:

NullArgumentException - vaultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasVaults

AliasResponseList aliasVaults(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

Adds an 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.

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.