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 Summary
Modifier and TypeMethodDescriptiongetInboundSynchronizations(ItemModel theItem) Returns all defined inbound synchronization sync jobs for a given item.getOutboundSynchronizations(ItemModel theItem) Returns all defined outbound synchronization sync jobs for a given item.getSyncInfo(ItemModel theItem, SyncItemJobModel syncItemJob) Gets theSyncItemStatusfrom the source of the synchronization side defined bysyncItemJobfor a given item.getSyncInfo(ItemModel theItem, List<SyncItemJobModel> syncItemJobs) Gets theSyncItemStatusfrom the all sources of the synchronization side defined bysyncItemJobsfor a given item.getSyncInfo(List<ItemModel> givenItems, SyncItemJobModel syncItemJob) Gets the list ofSyncItemStatusfrom the source of the synchronization side defined bysyncItemJobfor a given itemsgivenItems.booleanmatchesSyncStatus(List<ItemModel> givenItems, List<SyncItemJobModel> syncItemJobs, SyncItemStatus syncStatus) Convenient method that check whether given items are in one particularSyncItemStatusfor all the sources of the synchronization side defined bysyncItemJobs
-
Method Details
-
getSyncInfo
Gets theSyncItemStatusfrom the all sources of the synchronization side defined bysyncItemJobsfor a given item.- Parameters:
theItem- given itemsyncItemJobs- all synchronization jobs- Returns:
SyncItemStatus
-
getSyncInfo
Gets theSyncItemStatusfrom the source of the synchronization side defined bysyncItemJobfor a given item.- Parameters:
theItem- given itemsyncItemJob- synchronization jobs- Returns:
SyncItemStatus
-
getSyncInfo
Gets the list ofSyncItemStatusfrom the source of the synchronization side defined bysyncItemJobfor a given itemsgivenItems.- Parameters:
givenItems- list of given itemsyncItemJob- synchronization jobs- Returns:
SyncItemStatus
-
getInboundSynchronizations
Returns all defined inbound synchronization sync jobs for a given item. -
getOutboundSynchronizations
Returns all defined outbound synchronization sync jobs for a given item. -
matchesSyncStatus
boolean matchesSyncStatus(List<ItemModel> givenItems, List<SyncItemJobModel> syncItemJobs, SyncItemStatus syncStatus) Convenient method that check whether given items are in one particularSyncItemStatusfor all the sources of the synchronization side defined bysyncItemJobs- Parameters:
givenItems- list of given itemsyncItemJobs- synchronization jobssyncStatus-SyncItemStatus- Returns:
- true when all items match given status false otherwise
-