Package de.hybris.platform.catalog.synchronization

Class SyncConfig

java.lang.Object
de.hybris.platform.catalog.synchronization.SyncConfig
public class SyncConfig extends Object
Configuration container for starting a new catalog synchronization. Allows to override several settings of the underlying SyncItemCronJobModel and CatalogVersionSyncCronJobModel.

In addition it allows to schedule individual items to be synchronized and make the sync process running in partial mode. If no items are specified always a full sync is performed.

  • Constructor Details

    • SyncConfig

      public SyncConfig()

  • Method Details

    • getAbortWhenCollidingSyncIsRunning

      public boolean getAbortWhenCollidingSyncIsRunning()

    • setAbortWhenCollidingSyncIsRunning

      public void setAbortWhenCollidingSyncIsRunning(boolean abortWhenCollidingSyncIsRunning)

    • getLogToFile

      public Boolean getLogToFile()

    • setLogToFile

      public void setLogToFile(Boolean logToFile)

    • getLogToDatabase

      public Boolean getLogToDatabase()

    • setLogToDatabase

      public void setLogToDatabase(Boolean logToDatabase)

    • getForceUpdate

      public Boolean getForceUpdate()

    • setForceUpdate

      public void setForceUpdate(Boolean forceUpdate)

    • getKeepCronJob

      public Boolean getKeepCronJob()

    • setKeepCronJob

      public void setKeepCronJob(Boolean keepCronJob)

    • getLogLevelFile

      public JobLogLevel getLogLevelFile()

    • setLogLevelFile

      public void setLogLevelFile(JobLogLevel logLevelFile)

    • getLogLevelDatabase

      public JobLogLevel getLogLevelDatabase()

    • setLogLevelDatabase

      public void setLogLevelDatabase(JobLogLevel logLevelDatabase)

    • getCreateSavedValues

      public Boolean getCreateSavedValues()

    • setCreateSavedValues

      public void setCreateSavedValues(Boolean createSavedValues)

    • getErrorMode

      public ErrorMode getErrorMode()

    • setErrorMode

      public void setErrorMode(ErrorMode errorMode)

    • getSynchronous

      public Boolean getSynchronous()

    • setSynchronous

      public void setSynchronous(Boolean synchronous)

    • getFullSync

      @Deprecated(since="6.3.0", forRemoval=true) public Boolean getFullSync()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 6.3.0 - usehasPartialSyncSchedule() instead to determine whether a partial or full sync is to be executed

    • hasPartialSyncSchedule

      public boolean hasPartialSyncSchedule()
      Tells whether items have been added to the configuration and therefore the sync process is running in partial sync mode.

    • setFullSync

      @Deprecated(since="6.3.0", forRemoval=true) public void setFullSync(Boolean fullSync)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 6.3.0 - not used any more

    • addItemToSync

      public void addItemToSync(PK originalItemPK)
      Adds a specific item from the source catalog to be copied or updated. Even if no target item is specified here the process will detect the potentially existing copy.
      See Also:

    • addItemToSync

      public void addItemToSync(PK originalItemPK, PK copyItemPK)
      Adds a specific item from the source catalog to be copied or updated. This method allows to specify the existing copy of the item as well. Note that if the copy is omitted the sync process will perform a lookup for the copy any way.
      See Also:

    • addItemToDelete

      public void addItemToDelete(PK copyItemPK)
      Adds a specific item from the target catalog version to be removed within the sync process. Use this to schedule removal of items which no longer exists in the source catalog version. However, be aware of the sync not checking whether there's really no original left and just deletes the scheduled item!

    • getPartialSyncSchedule

      public List<PK[]> getPartialSyncSchedule()
      Returns the partial sync schedule or an empty list if a full sync is intended.
      See Also: