Package com.commercetools.sync.services

Interface TaxCategoryService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(java.util.Set<java.lang.String> taxCategoryKeys)
      Filters out the keys which are already cached and fetches only the not-cached tax category keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every tax category to id in the cached map of keys -> ids and returns this cached map.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.tax_category.TaxCategory>> createTaxCategory​(com.commercetools.api.models.tax_category.TaxCategoryDraft taxCategoryDraft)
      Given a resource draft of TaxCategoryDraft, this method attempts to create a resource TaxCategory based on it in the CTP project defined by the sync options.
      java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> fetchCachedTaxCategoryId​(java.lang.String key)
      Given a key, this method first checks if a cached map of TaxCategory keys -> ids is not empty.
      java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.tax_category.TaxCategory>> fetchMatchingTaxCategoriesByKeys​(java.util.Set<java.lang.String> keys)
      Given a Set of tax category keys, this method fetches a set of all the taxCategories, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.tax_category.TaxCategory>> fetchTaxCategory​(java.lang.String key)
      Given a tax category key, this method fetches a tax category that matches given key in the CTP project defined in a potentially injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<com.commercetools.api.models.tax_category.TaxCategory> updateTaxCategory​(com.commercetools.api.models.tax_category.TaxCategory taxCategory, java.util.List<com.commercetools.api.models.tax_category.TaxCategoryUpdateAction> updateActions)
      Given a TaxCategory and a List<TaxCategoryUpdateAction<TaxCategory>>, this method issues an update request with these update actions on this TaxCategory in the CTP project defined in a potentially injected ProjectApiRoot.

    • Method Detail

      • cacheKeysToIds

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(@Nonnull
                                                                                                            java.util.Set<java.lang.String> taxCategoryKeys)
        Filters out the keys which are already cached and fetches only the not-cached tax category keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every tax category to id in the cached map of keys -> ids and returns this cached map.
        Parameters:
        taxCategoryKeys - - a set of tax category keys to fetch and cache the ids for
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a map of requested tax category keys -> ids

      • fetchCachedTaxCategoryId

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> fetchCachedTaxCategoryId​(@Nullable
                                                                                                    java.lang.String key)
        Given a key, this method first checks if a cached map of TaxCategory 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 TaxCategory keys to ids in the CTP project, by querying the CTP project for all Tax categories.

        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 TaxCategory was found in the CTP project with this key.

        Parameters:
        key - the key by which a TaxCategory 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 TaxCategory was found in the CTP project with this key.

      • fetchMatchingTaxCategoriesByKeys

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.tax_category.TaxCategory>> fetchMatchingTaxCategoriesByKeys​(@Nonnull
                                                                                                                                            java.util.Set<java.lang.String> keys)
        Given a Set of tax category keys, this method fetches a set of all the taxCategories, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot. A mapping of the key to the id of the fetched taxCategories is persisted in an in-memory map.
        One must remember key is not required to create TaxCategory but is required to synchronize tax categories.
        Parameters:
        keys - set of tax category keys to fetch matching taxCategories by.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a Set of all matching taxCategories.

      • fetchTaxCategory

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.tax_category.TaxCategory>> fetchTaxCategory​(@Nullable
                                                                                                                                 java.lang.String key)
        Given a tax category key, this method fetches a tax category that matches given key in the CTP project defined in a potentially injected ProjectApiRoot. If there is no matching tax category an empty Optional will be returned in the returned future. A mapping of the key to the id of the fetched category is persisted in an in-memory map.
        Parameters:
        key - the key of the tax category to fetch.
        Returns:
        CompletionStage<Optional> in which the result of it's completion contains an Optional that contains the matching TaxCategory if exists, otherwise empty.

      • createTaxCategory

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.tax_category.TaxCategory>> createTaxCategory​(@Nonnull
                                                                                                                                  com.commercetools.api.models.tax_category.TaxCategoryDraft taxCategoryDraft)
        Given a resource draft of TaxCategoryDraft, this method attempts to create a resource TaxCategory based on it in the CTP project defined by the sync options.

        A completion stage containing an empty option 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 it's completion contains an instance Optional of the resource which was created.

        Parameters:
        taxCategoryDraft - 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.

      • updateTaxCategory

        @Nonnull
java.util.concurrent.CompletionStage<com.commercetools.api.models.tax_category.TaxCategory> updateTaxCategory​(@Nonnull
                                                                                                              com.commercetools.api.models.tax_category.TaxCategory taxCategory,
                                                                                                              @Nonnull
                                                                                                              java.util.List<com.commercetools.api.models.tax_category.TaxCategoryUpdateAction> updateActions)
        Given a TaxCategory and a List<TaxCategoryUpdateAction<TaxCategory>>, this method issues an update request with these update actions on this TaxCategory in the CTP project defined in a potentially injected ProjectApiRoot. This method returns CompletionStage<TaxCategory> in which the result of it's completion contains an instance of the TaxCategory which was updated in the CTP project.
        Parameters:
        taxCategory - the TaxCategory to update.
        updateActions - the update actions to update the TaxCategory with.
        Returns:
        CompletionStage<TaxCategory> containing as a result of it's completion an instance of the TaxCategory which was updated in the CTP project or a CompletionException.