Package de.hybris.platform.catalog.synchronization

Interface SynchronizationStatusService

  • All Known Implementing Classes:
    DefaultSynchronizationStatusService
    public interface SynchronizationStatusService
    A SynchronizationStatusService offers useful operations for perform more fine grained synchronization operations.

    Note: Below operations get current synchronization status for given items from a different sides i.e for convenience one can get synchronization status for an items that resides in the source as well in the target catalog version - just to get the status from the target catalog version side please use status methods that contains Pull in their names, other status methods computes the status from the source catalog version side.

    In addition to that what was stated above we can schedule the synchronization for a bunch of items.

    • Method Detail

      • getSyncInfo

        java.util.List<SyncItemInfo> getSyncInfo​(ItemModel theItem,
                                         java.util.List<SyncItemJobModel> syncItemJobs)
        Gets the SyncItemStatus from the all sources of the synchronization side defined by syncItemJobs for a given item.
        Parameters:
        theItem - given item
        syncItemJobs - all synchronization jobs
        Returns:
        SyncItemStatus

      • getSyncInfo

        java.util.List<SyncItemInfo> getSyncInfo​(java.util.List<ItemModel> givenItems,
                                         SyncItemJobModel syncItemJob)
        Gets the list of SyncItemStatus from the source of the synchronization side defined by syncItemJob for a given items givenItems.
        Parameters:
        givenItems - list of given item
        syncItemJob - synchronization jobs
        Returns:
        SyncItemStatus

      • getInboundSynchronizations

        java.util.List<SyncItemJobModel> getInboundSynchronizations​(ItemModel theItem)
        Returns all defined inbound synchronization sync jobs for a given item.

      • getOutboundSynchronizations

        java.util.List<SyncItemJobModel> getOutboundSynchronizations​(ItemModel theItem)
        Returns all defined outbound synchronization sync jobs for a given item.

      • matchesSyncStatus

        boolean matchesSyncStatus​(java.util.List<ItemModel> givenItems,
                          java.util.List<SyncItemJobModel> syncItemJobs,
                          SyncItemStatus syncStatus)
        Convenient method that check whether given items are in one particular SyncItemStatus for all the sources of the synchronization side defined by syncItemJobs
        Parameters:
        givenItems - list of given item
        syncItemJobs - synchronization jobs
        syncStatus - SyncItemStatus
        Returns:
        true when all items match given status false otherwise