de.hybris.platform.cms2.version.converter.rollback

Interface ItemRollbackConverter

All Known Implementing Classes:

ComponentRollbackConverter

public interface ItemRollbackConverter

Interface responsible for rollbacking an ItemModel.

Method Summary

Modifier and Type	Method and Description
java.util.function.Predicate<ItemModel>	getConstrainedBy() Predicate to verify whether current converter is applicable to provided ItemModel.
ItemModel	rollbackItem(ItemModel itemModel, CMSVersionModel versionModel, AuditPayload auditPayload) Rollbacks the itemModel to a desired version based on the information specified in the audit payload.

Method Detail

getConstrainedBy

java.util.function.Predicate<ItemModel> getConstrainedBy()

Predicate to verify whether current converter is applicable to provided ItemModel.

Returns:

the Predicate.

rollbackItem

ItemModel rollbackItem(ItemModel itemModel,
                       CMSVersionModel versionModel,
                       AuditPayload auditPayload)
                throws ItemRollbackException

Rollbacks the itemModel to a desired version based on the information specified in the audit payload.

Parameters:

itemModel - The ItemModel to rollback.

versionModel - The CMSVersionModel that identifies the version of the item to rollback to.

auditPayload - The serialized payload that specifies the information that the versioned item must contain.

Returns:

the rollbacked ItemModel.

Throws:

ItemRollbackException - if the ItemModel referenced cannot be rolled back.