de.hybris.platform.cmsfacades.synchronization

Interface SynchronizationFacade

All Known Implementing Classes:

DefaultSynchronizationFacade

public interface SynchronizationFacade

Facade for managing Synchronization.

Method Summary

Modifier and Type	Method and Description
SyncJobData	createCatalogSynchronization(SyncJobRequestData syncJobRequest) Attempts to create a synchronization job.
SyncJobData	getLastSynchronizationByCatalogTarget(SyncJobRequestData syncJobRequest) Get the status of the last synchronization job by SyncJobRequestData.
SyncJobData	getSynchronizationByCatalogSourceTarget(SyncJobRequestData syncJobRequest) Get a synchronization status by SyncJobRequestData.

Method Detail

getSynchronizationByCatalogSourceTarget

SyncJobData getSynchronizationByCatalogSourceTarget(SyncJobRequestData syncJobRequest)
                                             throws ValidationException

Get a synchronization status by SyncJobRequestData.

Parameters:

syncJobRequest - the synchronization request data

Returns:

the SyncJobData

Throws:

ValidationException - if there any validation errors.

getLastSynchronizationByCatalogTarget

SyncJobData getLastSynchronizationByCatalogTarget(SyncJobRequestData syncJobRequest)
                                           throws ValidationException

Get the status of the last synchronization job by SyncJobRequestData. Information is retrieved based on the catalog version target.

Parameters:

syncJobRequest - the synchronization request data

Returns:

the SyncJobData

Throws:

ValidationException - if there are any validation errors

createCatalogSynchronization

SyncJobData createCatalogSynchronization(SyncJobRequestData syncJobRequest)
                                  throws SynchronizationInProgressException,
                                         CMSItemNotFoundException

Attempts to create a synchronization job. It may not succeed due to internal constraints, and in this case it will throw an exception.

Parameters:

syncJobRequest - the synchronization request data

Returns:

the synchronization job status

Throws:

SynchronizationInProgressException - when the there is already a synchronization in progress

CMSItemNotFoundException - when it cannot find one of the catalog versions defined in the request.