org.osid.ordering.batch

Interface StoreBatchAdminSession

All Superinterfaces:

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

public interface StoreBatchAdminSession
extends StoreAdminSession

This session creates, updates, and deletes Stores 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 Store, a StoreForm is requested using getStoreFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned StoreForms 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 StoreForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each StoreForm corresponds to an attempted transaction.

The StoreForms returned from getStoreFormsForCreate() may be linked to the originating request through the peer Ids of the StoreForm. In the case where there may be duplicates, any StoreForm of the same peer Ids may be used for a create operation.

Once a batch of StoreForms are submitted for create, a CreateResponse is returned for each StoreForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createStores(), errors specific to an individual StoreForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating StoreForm through the StoreForm Id .

For updates, StoreForms are requested to the Store Id that is to be updated using getStoreFormsForUpdate() where the reference Id in the StoreForm may be used to link the request. Similarly, the StoreForm has metadata about the data that can be updated and it can perform validation before submitting the update. The StoreForm can only be used once for a successful update and cannot be reused.

Once a batch of StoreForms are submitted for update, an UpdateResponse is returned for each StoreForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateStores(), errors specific to an individual StoreForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating StoreForm through the StoreForm Id.

The delete operations delete Stores in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasStores(AliasRequestList aliasRequests) Adds an Id to a Store for the purpose of creating compatibility.
CreateResponseList	createStores(StoreBatchFormList storeForms) Creates a new set of Stores.
DeleteResponseList	deleteAllStores() Deletes all Stores.
DeleteResponseList	deleteStores(IdList storeIds) Deletes stores for the given Ids.
StoreBatchFormList	getStoreFormsForCreate(long number, Type[] storeRecordTypes) Gets the store forms for creating a bunch of new stores.
StoreBatchFormList	getStoreFormsForUpdate(IdList storeIds) Gets the store forms for updating an existing set of stores.
UpdateResponseList	updateStores(StoreBatchFormList storeForms) Updates existing stores.

Methods inherited from interface org.osid.ordering.StoreAdminSession

aliasStore, canCreateStores, canCreateStoreWithRecordTypes, canDeleteStores, canManageStoreAliases, canUpdateStores, createStore, deleteStore, getStoreFormForCreate, getStoreFormForUpdate, updateStore

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

getStoreFormsForCreate

StoreBatchFormList getStoreFormsForCreate(long number,
                                        Type[] storeRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the store forms for creating a bunch of new stores.

Parameters:

number - the number of forms to retrieve

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

Returns:

the store forms

Throws:

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

createStores

CreateResponseList createStores(StoreBatchFormList storeForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

storeForms - the store forms

Returns:

the create responses

Throws:

NullArgumentException - storeForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoreFormsForUpdate

StoreBatchFormList getStoreFormsForUpdate(IdList storeIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

storeIds - the Ids of the Store

Returns:

the store form

Throws:

NotFoundException - a storeId is not found

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateStores

UpdateResponseList updateStores(StoreBatchFormList storeForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

storeForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - storeForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllStores

DeleteResponseList deleteAllStores()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Stores.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteStores

DeleteResponseList deleteStores(IdList storeIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes stores for the given Ids.

Parameters:

storeIds - the Ids of the stores to delete

Returns:

the delete responses

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasStores

AliasResponseList aliasStores(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

Adds an Id to a Store for the purpose of creating compatibility. The primary Id of the Store is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another store, it is reassigned to the given store 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.