public interface ProductBatchAdminSession extends ProductAdminSession
This session creates, updates, and deletes Products
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
Product,
a ProductForm
is requested using
getProductFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned ProductForms
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 ProductForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
ProductForm
corresponds to an attempted transaction.
The ProductForms
returned from
getProductFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ProductForm.
In the case where there may be duplicates, any ProductForm
of the same peer Ids
may be used for a create
operation.
Once a batch of ProductForms
are submitted for create,
a CreateResponse
is returned for each ProductForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createProducts(),
errors specific to an individual ProductForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
ProductForm
through the ProductForm
Id
.
For updates, ProductForms
are requested to the
Product
Id
that is to be updated using
getProductFormsForUpdate()
where the reference Id
in the ProductForm
may be used to link the request.
Similarly, the ProductForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The ProductForm
can only be used once for a successful
update and cannot be reused.
Once a batch of ProductForms
are submitted for update,
an UpdateResponse
is returned for each ProductForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateProducts(),
errors specific to an individual ProductForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ProductForm
through the ProductForm
Id.
The delete operations delete Products
in bulk. To unmap
a Product
from the current Store,
the
ProductStoreAssignmentSession
should be used. These delete
operations attempt to remove the Product
itself thus
removing it from all known Store
catalogs. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasProducts(AliasRequestList aliasRequests)
Adds an
Id to a Product for the purpose
of creating compatibility. |
CreateResponseList |
createProducts(ProductBatchFormList productForms)
Creates a new set of
Products. |
DeleteResponseList |
deleteAllProducts()
Deletes all
Products in this Store . |
DeleteResponseList |
deleteProducts(IdList productIds)
Deletes products for the given
Ids. |
ProductBatchFormList |
getProductFormsForCreate(long number,
Type[] productRecordTypes)
Gets the product forms for creating a bunch of new products
|
ProductBatchFormList |
getProductFormsForUpdate(IdList productIds)
Gets the product forms for updating an existing set of products.
|
UpdateResponseList |
updateProducts(ProductBatchFormList productForms)
Updates existing products.
|
aliasProduct, canCreateProducts, canCreateProductWithRecordTypes, canDeleteProducts, canManageProductAliases, canUpdateProducts, createProduct, deleteProduct, getProductFormForCreate, getProductFormForUpdate, getStore, getStoreId, updateProduct
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProductBatchFormList getProductFormsForCreate(long number, Type[] productRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveproductRecordTypes
- array of product record types to be
included in each create operation or an empty list if noneNullArgumentException
- productRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createProducts(ProductBatchFormList productForms) throws OperationFailedException, PermissionDeniedException
Products.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.productForms
- the product formsNullArgumentException
- productForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProductBatchFormList getProductFormsForUpdate(IdList productIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
productIds
- the Ids
of the Product
NotFoundException
- a productId
is not
foundNullArgumentException
- productIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateProducts(ProductBatchFormList productForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.productForms
- the form containing the elements to be updatedNullArgumentException
- productForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllProducts() throws OperationFailedException, PermissionDeniedException
Products
in this Store
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProducts(IdList productIds) throws OperationFailedException, PermissionDeniedException
Ids.
productIds
- the Ids
of the products to deleteNullArgumentException
- productIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasProducts(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Product
for the purpose
of creating compatibility. The primary Id
of the
Product
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another product, it is reassigned to the given product
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.