de.hybris.platform.cmsfacades.synchronization

Interface ItemSynchronizationFacade

All Known Implementing Classes:

DefaultItemSynchronizationFacade

public interface ItemSynchronizationFacade

The ItemSynchronizationFacade facade is responsible for providing methods for getting the synchronization status of a specific ItemModel.

Method Summary

Modifier and Type	Method and Description
SyncItemStatusData	getSynchronizationItemStatus(SyncRequestData syncRequestData, ItemSynchronizationData itemSynchronizationData) Retrieves the synchronization status for a given ItemModel.
SyncItemStatusData	getSynchronizationItemStatus(SyncRequestData syncRequestData, ItemSynchronizationData itemSynchronizationData, SyncItemStatusConfig config) Retrieves the synchronization status for a given ItemModel.
void	performItemSynchronization(SyncRequestData syncRequestData, SynchronizationData synchronizationData) Performs the synchronization for a list of ItemModel.
void	performItemSynchronization(SyncRequestData syncRequestData, SynchronizationData synchronizationData, SyncConfig config) Performs the synchronization for a list of ItemModel.

Method Detail

getSynchronizationItemStatus

SyncItemStatusData getSynchronizationItemStatus(SyncRequestData syncRequestData,
                                                ItemSynchronizationData itemSynchronizationData)

Retrieves the synchronization status for a given ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions. The implementation should provide a default maximum depth property to prevent the mechanism to crawl too many items.

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

itemSynchronizationData - the pair of identifier/type to retrieve the ItemModel of which we want to get the synchronization status

Returns:

the synchronization status details for a given ItemModel.

Throws:

java.lang.IllegalArgumentException - when the default maximum depth configuration is not greater than zero.

getSynchronizationItemStatus

SyncItemStatusData getSynchronizationItemStatus(SyncRequestData syncRequestData,
                                                ItemSynchronizationData itemSynchronizationData,
                                                SyncItemStatusConfig config)

Retrieves the synchronization status for a given ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions. This method lets the client decide what is the maximum depth level to navigate on the item's dependencies.

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

itemSynchronizationData - the pair of identifier/type to retrieve the ItemModel of which we want to get the synchronization status

config - the get status configuration. See SyncItemStatusConfig for more details.

Returns:

the synchronization status details for a given ItemModel.

Throws:

java.lang.IllegalArgumentException - when the maximum depth configuration is not greater than zero.

performItemSynchronization

void performItemSynchronization(SyncRequestData syncRequestData,
                                SynchronizationData synchronizationData)

Performs the synchronization for a list of ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions.

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

synchronizationData - contains the list of ItemSynchronizationData pairs of itemId/itemType that we want to synchronize

performItemSynchronization

void performItemSynchronization(SyncRequestData syncRequestData,
                                SynchronizationData synchronizationData,
                                SyncConfig config)

Performs the synchronization for a list of ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions.

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

synchronizationData - contains the list of pairs of ItemSynchronizationData itemId/itemType that we want to synchronize

config - the synchronization configuration . See SyncConfig for more details.