com.commercetools.sync.services.UnresolvedReferencesService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-sync-java Show documentation

Java Library used to import and/or sync (taking care of changes) data into one or more commercetools projects from external sources such as CSV, XML, JSON, etc.. or even from an already existing commercetools project.

The newest version!

package com.commercetools.sync.services;

import com.commercetools.sync.commons.models.WaitingToBeResolved;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletionStage;
import javax.annotation.Nonnull;

public interface UnresolvedReferencesService {

  /**
   * Given draft keys, this method fetches the persisted drafts waiting to be resolved. If there is
   * no matching draft, an empty {@link java.util.Set} will be returned in the returned future.
   *
   * @param keys the keys of the persisted drafts, waiting to be resolved, to fetch.
   * @param containerKey the key of the container, which contains the persisted draft
   * @param clazz Class of the object contained by custom object
   * @return {@link java.util.concurrent.CompletionStage}<{@link java.util.Set}> in which the
   *     result of its completion contains a {@link java.util.Set} that contains the matching drafts
   *     if any exist, otherwise empty.
   */
  @Nonnull
  CompletionStage> fetch(
      @Nonnull final Set keys,
      @Nonnull final String containerKey,
      @Nonnull Class clazz);

  /**
   * Persists a draft that is not ready to be resolved yet.
   *
   * @param draft the draft that should be persisted.
   * @param containerKey the key of the container, which contains the persisted draft
   * @param clazz Class of the object contained by custom object
   * @return a {@link java.util.concurrent.CompletionStage} containing an optional with the created
   *     resource if successful otherwise an empty optional.
   */
  @Nonnull
  CompletionStage> save(
      @Nonnull final WaitingToBeResolvedT draft,
      @Nonnull final String containerKey,
      @Nonnull final Class clazz);

  /**
   * Given a draft key, this methods deletes the matching draft from persistence.
   *
   * @param key the key of the draft to delete from persistence.
   * @param containerKey the key of the container, which contains the persisted draft
   * @param clazz Class of the object contained by custom object
   * @return a {@link java.util.concurrent.CompletionStage} containing an optional with the deleted
   *     resource if successful otherwise an empty optional.
   */
  @Nonnull
  CompletionStage> delete(
      @Nonnull final String key,
      @Nonnull final String containerKey,
      @Nonnull final Class clazz);
}