com.commercetools.sync.services

Interface TypeService

All Known Implementing Classes:

TypeServiceImpl

public interface TypeService

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.types.Type>>	createType(io.sphere.sdk.types.TypeDraft typeDraft) Given a resource draft of type TypeDraft, this method attempts to create a resource Type based on it in the CTP project defined by the sync options.
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>>	fetchCachedTypeId(java.lang.String key) Given a key, this method first checks if a cached map of Type keys -> ids is not empty.
java.util.concurrent.CompletionStage<java.util.Set<io.sphere.sdk.types.Type>>	fetchMatchingTypesByKeys(java.util.Set<java.lang.String> keys) Given a Set of Type keys, this method fetches a set of all the Types, matching this given set of keys in the CTP project, defined in an injected SphereClient.
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.types.Type>>	fetchType(java.lang.String key) Given a type key, this method fetches a type that matches this given key in the CTP project defined in an injected SphereClient.
java.util.concurrent.CompletionStage<io.sphere.sdk.types.Type>	updateType(io.sphere.sdk.types.Type type, java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.types.Type>> updateActions) Given a Type and a List<UpdateAction<Type>>, this method issues an update request with these update actions on this Type in the CTP project defined in an injected SphereClient.

Method Detail

fetchCachedTypeId

@Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> fetchCachedTypeId(@Nonnull
                                                                                                      java.lang.String key)

Given a key, this method first checks if a cached map of Type keys -> ids is not empty. If not, it returns a completed future that contains an optional that contains what this key maps to in the cache. If the cache is empty, the method populates the cache with the mapping of all Type keys to ids in the CTP project, by querying the CTP project for all Types.

After that, the method returns a CompletionStage<Optional<String>> in which the result of it's completion could contain an Optional with the id inside of it or an empty Optional if no Channel was found in the CTP project with this key.

Parameters:

key - the key by which a Type id should be fetched from the CTP project.

Returns:

CompletionStage<Optional<String>> in which the result of its completion could contain an Optional with the id inside of it or an empty Optional if no Channel was found in the CTP project with this key.

fetchMatchingTypesByKeys

@Nonnull
java.util.concurrent.CompletionStage<java.util.Set<io.sphere.sdk.types.Type>> fetchMatchingTypesByKeys(@Nonnull
                                                                                                                java.util.Set<java.lang.String> keys)

Given a Set of Type keys, this method fetches a set of all the Types, matching this given set of keys in the CTP project, defined in an injected SphereClient. A mapping of the key to the id of the fetched Type is persisted in an in-memory map.

Parameters:

keys - set of Type keys to fetch matching Type by.

Returns:

CompletionStage<Map> in which the result of its completion contains a Set of all matching Types.

fetchType

@Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.types.Type>> fetchType(@Nullable
                                                                                                      java.lang.String key)

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

Parameters:

key - the key of the type to fetch.

Returns:

CompletionStage<Optional> in which the result of its completion contains an Optional that contains the matching Type if exists, otherwise empty.

createType

@Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.types.Type>> createType(@Nonnull
                                                                                                       io.sphere.sdk.types.TypeDraft typeDraft)

Given a resource draft of type TypeDraft, this method attempts to create a resource Type based on it in the CTP project defined by the sync options.

A completion stage containing an empty optional and the error callback will be triggered in those cases:

• the draft has a blank key
• the create request fails on CTP

On the other hand, if the resource gets created successfully on CTP, then the created resource's id and key are cached and the method returns a CompletionStage in which the result of its completion contains an instance Optional of the resource which was created.

Parameters:

typeDraft - the resource draft to create a resource based off of.

Returns:

a CompletionStage containing an optional with the created resource if successful otherwise an empty optional.

updateType

@Nonnull
java.util.concurrent.CompletionStage<io.sphere.sdk.types.Type> updateType(@Nonnull
                                                                                   io.sphere.sdk.types.Type type,
                                                                                   @Nonnull
                                                                                   java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.types.Type>> updateActions)

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

Parameters:

type - the Type to update.

updateActions - the update actions to update the Type with.

Returns:

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