org.broadleafcommerce.common.persistence

Interface EntityDuplicatorExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

DuplicationValidatorExtensionHandlerImpl, EntityDuplicatorExtensionManager

public interface EntityDuplicatorExtensionHandler
extends ExtensionHandler

Allow other modules to contribute to the duplication lifecycle

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	addToSandbox(Object entity) Add duplication entity to the sandbox
ExtensionResultStatusType	getCatalogsForPropagation(MultiTenantCopyContext context, ExtensionResultHolder<List<MultiTenantCopyContext>> resultHolder)
ExtensionResultStatusType	getClonesByCatalogs(String tableName, Long id, MultiTenantCopyContext multiTenantCopyContext, ExtensionResultHolder<Map<Long,Map<Long,Long>>> resultHolder)
ExtensionResultStatusType	setupDuplicate(Object entity, ExtensionResultHolder<MultiTenantCopyContext> resultHolder) Perform any required context and state setup before commencing with the duplication
ExtensionResultStatusType	tearDownDuplicate() Tear down any expired context and state used during the duplication
ExtensionResultStatusType	validateDuplicate(Object entity, ExtensionResultHolder<Boolean> resultHolder) Confirm whether or not duplication operation is allowed

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Detail

validateDuplicate

ExtensionResultStatusType validateDuplicate(Object entity,
                                            ExtensionResultHolder<Boolean> resultHolder)

Confirm whether or not duplication operation is allowed

Parameters:

entity -

resultHolder -

Returns:

setupDuplicate

ExtensionResultStatusType setupDuplicate(Object entity,
                                         ExtensionResultHolder<MultiTenantCopyContext> resultHolder)

Perform any required context and state setup before commencing with the duplication

Parameters:

entity -

resultHolder -

Returns:

addToSandbox

ExtensionResultStatusType addToSandbox(Object entity)

Add duplication entity to the sandbox

Parameters:

entity -

Returns:

tearDownDuplicate

ExtensionResultStatusType tearDownDuplicate()

Tear down any expired context and state used during the duplication

Returns:

getCatalogsForPropagation

ExtensionResultStatusType getCatalogsForPropagation(MultiTenantCopyContext context,
                                                    ExtensionResultHolder<List<MultiTenantCopyContext>> resultHolder)

getClonesByCatalogs

ExtensionResultStatusType getClonesByCatalogs(String tableName,
                                              Long id,
                                              MultiTenantCopyContext multiTenantCopyContext,
                                              ExtensionResultHolder<Map<Long,Map<Long,Long>>> resultHolder)