Package com.commercetools.sync.inventories.utils

Class InventoryReferenceResolutionUtils

  • public final class InventoryReferenceResolutionUtils
extends java.lang.Object
    Util class which provides utilities that can be used when syncing resources from a source commercetools project to a target one.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static io.sphere.sdk.inventory.queries.InventoryEntryQuery buildInventoryQuery()
      Builds a InventoryEntryQuery for fetching inventories from a source CTP project with all the needed references expanded for the sync: Custom Type Supply Channel
      static java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> mapToInventoryEntryDrafts​(java.util.List<io.sphere.sdk.inventory.InventoryEntry> inventoryEntries)
      Returns an List<InventoryEntryDraft> consisting of the results of applying the mapping from InventoryEntry to InventoryEntryDraft with considering reference resolution.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • mapToInventoryEntryDrafts

        @Nonnull
public static java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> mapToInventoryEntryDrafts​(@Nonnull
                                                                                                    java.util.List<io.sphere.sdk.inventory.InventoryEntry> inventoryEntries)
        Returns an List<InventoryEntryDraft> consisting of the results of applying the mapping from InventoryEntry to InventoryEntryDraft with considering reference resolution.
        Mapping of Reference fields for the reference resolution
        Reference field from to
        supplyChannel Reference<Channel> ResourceIdentifier<Channel>
        custom.type Reference<Type> ResourceIdentifier<Type>

        Note: The Channel and Type references should be expanded with a key. Any reference that is not expanded will have its id in place and not replaced by the key will be considered as existing resources on the target commercetools project and the library will issues an update/create API request without reference resolution.

        Parameters:
        inventoryEntries - the inventory entries with expanded references.
        Returns:
        a List of InventoryEntryDraft built from the supplied List of InventoryEntry.

      • buildInventoryQuery

        public static io.sphere.sdk.inventory.queries.InventoryEntryQuery buildInventoryQuery()
        Builds a InventoryEntryQuery for fetching inventories from a source CTP project with all the needed references expanded for the sync:
        • Custom Type
        • Supply Channel

        Note: Please only use this util if you desire to sync all the aforementioned references from a source commercetools project. Otherwise, it is more efficient to build the query without expansions, if they are not needed, to avoid unnecessarily bigger payloads fetched from the source project.

        Returns:
        the query for fetching inventories from the source CTP project with all the aforementioned references expanded.