Interface ItemSynchronizationService

  • All Known Implementing Classes:
    DefaultItemSynchronizationService

    public interface ItemSynchronizationService
    The ItemSynchronizationService is responsible for getting the synchronization status details for an item.
    • Method Detail

      • getSynchronizationItemStatus

        SynchronizationItemDetailsData getSynchronizationItemStatus​(SyncRequestData syncRequestData,
                                                                    ItemModel item)
        Gets the synchronization item status for a given ItemModel taking in consideration the source and target catalog versions. Implementations should be able to provide details of the synchronization status of related items as well.
        Parameters:
        syncRequestData - the synchronization request containing the source and target catalog versions
        item - the item model we are interested in getting the synchronization status
        Returns:
        an instance of SynchronizationItemDetailsData, never null.
        Throws:
        java.lang.IllegalArgumentException - when any of the given parameters is null.
      • performItemSynchronization

        void performItemSynchronization​(SyncRequestData syncRequestData,
                                        java.util.List<ItemModel> items,
                                        SyncConfig config)
        performs the synchronization of a list of ItemModel taking in consideration the source and target catalog versions. Implementations should be able to provide details of the synchronization status of related items as well.
        Parameters:
        syncRequestData - the synchronization request containing the source and target catalog versions
        items - the list of item models that we want to synchronize
        config - the synchronization configuration . See SyncConfig for more details.