Interface SetupSyncJobService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void assignDependentSyncJobs​(java.lang.String catalogId, java.util.Set<java.lang.String> dependentCatalogIds)
      Sets up a dependency relationship between the CatalogVersionSyncJob for a catalog and the CatalogVersionSyncJobs for a set of dependant catalogs.
      void createContentCatalogSyncJob​(java.lang.String catalogId)
      Ensure that a cms content catalog sync job exists for the specified catalog id.
      void createProductCatalogSyncJob​(java.lang.String catalogId)
      Ensure that a product catalog sync job exists for the specified catalog id.
      PerformResult executeCatalogSyncJob​(java.lang.String catalogId)
      Run the catalog sync for the specified catalog.
    • Method Detail

      • createProductCatalogSyncJob

        void createProductCatalogSyncJob​(java.lang.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​(java.lang.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​(java.lang.String catalogId,
                                     java.util.Set<java.lang.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​(java.lang.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