com.commercetools.sync.inventories.utils.InventorySyncUtils Maven / Gradle / Ivy

Go to download
package com.commercetools.sync.inventories.utils;

import static com.commercetools.sync.commons.utils.CustomUpdateActionUtils.buildPrimaryResourceCustomUpdateActions;
import static com.commercetools.sync.commons.utils.OptionalUtils.filterEmptyOptionals;

import com.commercetools.api.models.inventory.InventoryEntry;
import com.commercetools.api.models.inventory.InventoryEntryDraft;
import com.commercetools.api.models.inventory.InventoryEntryUpdateAction;
import com.commercetools.sync.commons.BaseSyncOptions;
import com.commercetools.sync.inventories.InventorySyncOptions;
import com.commercetools.sync.inventories.helpers.InventoryCustomActionBuilder;
import com.commercetools.sync.inventories.models.InventoryEntryCustomTypeAdapter;
import com.commercetools.sync.inventories.models.InventoryEntryDraftCustomTypeAdapter;
import java.util.List;
import javax.annotation.Nonnull;

/** This class provides factory methods for assembling update actions of inventory entries. */
public final class InventorySyncUtils {
  private static final InventoryCustomActionBuilder inventoryCustomActionBuilder =
      new InventoryCustomActionBuilder();

  /**
   * Compares the quantityOnStock, the restockableInDays, the expectedDelivery, the supply channel
   * and Custom fields/ type fields of an {@link InventoryEntry} and an {@link InventoryEntryDraft}.
   * It returns a {@link List} of {@link InventoryEntryUpdateAction} as a result. If no update
   * action is needed an empty {@link List} is returned.
   *
   * @param oldEntry the inventory entry which should be updated
   * @param newEntry the inventory entry draft that contains new data that should be applied to
   *     {@code oldEntry}
   * @param syncOptions the sync options wrapper which contains options related to the sync process
   *     supplied by the user. For example, custom callbacks to call in case of warnings or errors
   *     occurring on the build update action process. And other options (See {@link
   *     BaseSyncOptions} for more info.
   * @return list containing {@link InventoryEntryUpdateAction} that need to be performed on {@code
   *     oldEntry} resource so that it will be synced with {@code newEntry} or empty list when both
   *     entries are already in sync.
   */
  @Nonnull
  public static List buildActions(
      @Nonnull final InventoryEntry oldEntry,
      @Nonnull final InventoryEntryDraft newEntry,
      @Nonnull final InventorySyncOptions syncOptions) {

    final List actions =
        filterEmptyOptionals(
            InventoryUpdateActionUtils.buildChangeQuantityAction(oldEntry, newEntry),
            InventoryUpdateActionUtils.buildSetRestockableInDaysAction(oldEntry, newEntry),
            InventoryUpdateActionUtils.buildSetExpectedDeliveryAction(oldEntry, newEntry),
            InventoryUpdateActionUtils.buildSetSupplyChannelAction(oldEntry, newEntry));

    actions.addAll(
        buildPrimaryResourceCustomUpdateActions(
            InventoryEntryCustomTypeAdapter.of(oldEntry),
            InventoryEntryDraftCustomTypeAdapter.of(newEntry),
            inventoryCustomActionBuilder,
            syncOptions));
    return actions;
  }

  private InventorySyncUtils() {}
}