com.commercetools.sync.services

Interface ProductService

All Known Implementing Classes:

ProductServiceImpl

public interface ProductService

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,java.lang.String>>	cacheKeysToIds() If not already done once before, it fetches all the product keys from the CTP project defined in a potentially injected SphereClient and stores a mapping for every product to id in Map and returns this cached map.
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.products.Product>>	createProduct(io.sphere.sdk.products.ProductDraft productDraft) Given a ProductDraft, this method creates a Product based on it in the CTP project defined in a potentially injected SphereClient.
java.util.concurrent.CompletionStage<java.util.Set<io.sphere.sdk.products.Product>>	createProducts(java.util.Set<io.sphere.sdk.products.ProductDraft> productsDrafts) Given a Set of productsDrafts, this method creates Products corresponding to them in the CTP project defined in a potentially injected SphereClient.
java.util.concurrent.CompletionStage<java.util.Set<io.sphere.sdk.products.Product>>	fetchMatchingProductsByKeys(java.util.Set<java.lang.String> productKeys) Given a Set of product keys, this method fetches a set of all the products matching this given set of keys in the CTP project defined in a potentially injected SphereClient.
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.products.Product>>	fetchProduct(java.lang.String key) Given a product key, this method fetches a product that matches this given key in the CTP project defined in a potentially injected SphereClient.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.Product>	publishProduct(io.sphere.sdk.products.Product product) Given a Product, this method issues an update request to publish this Product in the CTP project defined in a potentially injected SphereClient.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.Product>	revertProduct(io.sphere.sdk.products.Product product) Given a Product, this method issues an update request to revert the staged changes of this Product in the CTP project defined in a potentially injected SphereClient.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.Product>	updateProduct(io.sphere.sdk.products.Product product, java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.products.Product>> updateActions) Given a Product and a List<UpdateAction<Product>>, this method issues an update request with these update actions on this Product in the CTP project defined in a potentially injected SphereClient.

Method Detail

cacheKeysToIds

@Nonnull
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,java.lang.String>> cacheKeysToIds()

If not already done once before, it fetches all the product keys from the CTP project defined in a potentially injected SphereClient and stores a mapping for every product to id in Map and returns this cached map.

Returns:

CompletionStage<Map> in which the result of it's completion contains a map of all product keys -> ids

fetchMatchingProductsByKeys

@Nonnull
java.util.concurrent.CompletionStage<java.util.Set<io.sphere.sdk.products.Product>> fetchMatchingProductsByKeys(@Nonnull
                                                                                                                         java.util.Set<java.lang.String> productKeys)

Given a Set of product keys, this method fetches a set of all the products matching this given set of keys in the CTP project defined in a potentially injected SphereClient.

Parameters:

productKeys - set of product keys to fetch matching products by.

Returns:

CompletionStage<Map> in which the result of it's completion contains a Set of all matching products.

fetchProduct

@Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.products.Product>> fetchProduct(@Nonnull
                                                                                                               java.lang.String key)

Given a product key, this method fetches a product that matches this given key in the CTP project defined in a potentially injected SphereClient. If there is no matching product an empty Optional will be returned in the returned future.

Parameters:

key - the key of the product to fetch.

Returns:

CompletionStage<Optional> in which the result of it's completion contains an Optional that contains the matching Product if exists, otherwise empty.

createProducts

@Nonnull
java.util.concurrent.CompletionStage<java.util.Set<io.sphere.sdk.products.Product>> createProducts(@Nonnull
                                                                                                            java.util.Set<io.sphere.sdk.products.ProductDraft> productsDrafts)

Given a Set of productsDrafts, this method creates Products corresponding to them in the CTP project defined in a potentially injected SphereClient.

Parameters:

productsDrafts - set of productsDrafts to create on the CTP project.

Returns:

CompletionStage<Map> in which the result of it's completion contains a Set of all created products.

createProduct

@Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.products.Product>> createProduct(@Nonnull
                                                                                                                io.sphere.sdk.products.ProductDraft productDraft)

Given a ProductDraft, this method creates a Product based on it in the CTP project defined in a potentially injected SphereClient. The created product's id and key are also cached. This method returns CompletionStage<Product> in which the result of it's completion contains an instance of the Product which was created in the CTP project.

Parameters:

productDraft - the ProductDraft to create a Product based off of.

Returns:

CompletionStage<Product> containing as a result of it's completion an instance of the Product which was created in the CTP project or a SphereException.

updateProduct

@Nonnull
java.util.concurrent.CompletionStage<io.sphere.sdk.products.Product> updateProduct(@Nonnull
                                                                                            io.sphere.sdk.products.Product product,
                                                                                            @Nonnull
                                                                                            java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.products.Product>> updateActions)

Given a Product and a List<UpdateAction<Product>>, this method issues an update request with these update actions on this Product in the CTP project defined in a potentially injected SphereClient. This method returns CompletionStage<Product> in which the result of it's completion contains an instance of the Product which was updated in the CTP project.

Parameters:

product - the Product to update.

updateActions - the update actions to update the Product with.

Returns:

CompletionStage<Product> containing as a result of it's completion an instance of the Product which was updated in the CTP project or a SphereException.

publishProduct

@Nonnull
java.util.concurrent.CompletionStage<io.sphere.sdk.products.Product> publishProduct(@Nonnull
                                                                                             io.sphere.sdk.products.Product product)

Given a Product, this method issues an update request to publish this Product in the CTP project defined in a potentially injected SphereClient. This method returns CompletionStage<Product> in which the result of it's completion contains an instance of the Product which was published in the CTP project.

Parameters:

product - the Product to publish.

Returns:

CompletionStage<Product> containing as a result of it's completion an instance of the Product which was published in the CTP project or a SphereException.

revertProduct

@Nonnull
java.util.concurrent.CompletionStage<io.sphere.sdk.products.Product> revertProduct(@Nonnull
                                                                                            io.sphere.sdk.products.Product product)

Given a Product, this method issues an update request to revert the staged changes of this Product in the CTP project defined in a potentially injected SphereClient. This method returns CompletionStage<Product> in which the result of it's completion contains an instance of the Product which had its staged changes reverted in the CTP project.

Parameters:

product - the Product to revert the staged changes for.

Returns:

CompletionStage<Product> containing as a result of it's completion an instance of the Product which was published in the CTP project or a SphereException.