Interface SetupSyncJobService

All Known Implementing Classes:
DefaultSetupSyncJobService, MarketplaceSetupSyncJobService

public interface SetupSyncJobService
Service that handles creating synchronization jobs.
  • Method Details

    • createProductCatalogSyncJob

      void createProductCatalogSyncJob(String catalogId)
      Ensure that a product catalog sync job exists for the specified catalog id. The sync job is created between the Staged and Online catalog versions only if there is no existing sync job.
      Parameters:
      catalogId - the catalog id to search sync job for.
    • createContentCatalogSyncJob

      void createContentCatalogSyncJob(String catalogId)
      Ensure that a cms content catalog sync job exists for the specified catalog id. The sync job is created between the Staged and Online catalog versions only if there is no existing sync job.
      Parameters:
      catalogId - the catalog id
    • assignDependentSyncJobs

      void assignDependentSyncJobs(String catalogId, Set<String> dependentCatalogIds)
      Sets up a dependency relationship between the CatalogVersionSyncJob for a catalog and the CatalogVersionSyncJobs for a set of dependant catalogs.
      Parameters:
      catalogId - the catalog id
      dependentCatalogIds - the dependant catalog ids
    • executeCatalogSyncJob

      PerformResult executeCatalogSyncJob(String catalogId)
      Run the catalog sync for the specified catalog.
      Parameters:
      catalogId - the catalog id
      Returns:
      an instance of PerformResult containing the sync job result and status