Package com.broadleafcommerce.bulkoperations.service.provider

Interface SandboxProvider<I extends CatalogItem>

Type Parameters:
I - The type of the results expected in the ChangeInfoResponse. Should extend CatalogItem.
All Known Implementing Classes:
ExternalSandboxProvider
public interface SandboxProvider<I extends CatalogItem>
Provider for interfacing with operations around sandboxing. Typically utilizes WebClient to make requests to an external REST API.
Since:
Bulk Operations Service 1.0.2, Release Train 2.1.4, Release Train 2.2.0
Author:
Jon Fleschler (jfleschler)

  • Method Summary

    Modifier and Type
    Method
    Description
    ChangeInfoResponse
    retrieveChangeInfos(String changeContainerId, String changeContainerName, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves the list of ChangeInfos for the given change container id.
    void
    revertChangeSummaries(Collection<String> ids, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reverts the change summaries for the given list of ids.

  • Method Details

    • retrieveChangeInfos

      ChangeInfoResponse retrieveChangeInfos(String changeContainerId, String changeContainerName, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves the list of ChangeInfos for the given change container id.
      Parameters:
      changeContainerId - the change container id to retrieve
      changeContainerName - the name of the change container
      contextInfo - context information surrounding sandboxing/multitenant state
      Returns:
      the list of ChangeInfos for the given change container id

    • revertChangeSummaries

      void revertChangeSummaries(Collection<String> ids, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reverts the change summaries for the given list of ids.
      Parameters:
      ids - the list of ids to revert
      contextInfo - context information surrounding sandboxing/multitenant state