Interface SynchronizationFacade
- All Known Implementing Classes:
DefaultSynchronizationFacade
public interface SynchronizationFacade
Facade for managing Synchronization.
-
Method Summary
Modifier and TypeMethodDescriptioncreateCatalogSynchronization(SyncRequestData syncJobRequest) Attempts to create a synchronization job.getLastSynchronizationByCatalogTarget(SyncRequestData syncJobRequest) Get the status of the last synchronization job bySyncRequestData.getSynchronizationByCatalogSourceTarget(SyncRequestData syncJobRequest) Get a synchronization status bySyncRequestData.
-
Method Details
-
getSynchronizationByCatalogSourceTarget
SyncJobData getSynchronizationByCatalogSourceTarget(SyncRequestData syncJobRequest) throws ValidationException Get a synchronization status bySyncRequestData.- Parameters:
syncJobRequest- the synchronization request data- Returns:
- the
SyncJobData - Throws:
ValidationException- if there any validation errors.
-
getLastSynchronizationByCatalogTarget
SyncJobData getLastSynchronizationByCatalogTarget(SyncRequestData syncJobRequest) throws ValidationException Get the status of the last synchronization job bySyncRequestData. 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(SyncRequestData 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 progressCMSItemNotFoundException- when it cannot find one of the catalog versions defined in the request.
-