org.broadleafcommerce.common.persistence

Interface EntityDuplicator

All Known Implementing Classes:

EntityDuplicatorImpl

public interface EntityDuplicator

Create a production duplicate of an entity. In the case of the enterprise module, the entity to be duplicated may not be a sandbox copy. In the case of the multitenant module, the entity to be duplicated must not be referenced in a derived catalog (apart from a standard site override) and must not be owned by another site.

The feature must first be enabled before use. To enable, add the following property to your Spring property file:

admin.entity.duplication.isactive=true

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
<T> T	copy(Class<T> entityClass, Long id, Map<String,String> copyHints, EntityDuplicateModifier... modifiers) Create a production duplicate of the entity specified in the params.
<T> T	copy(MultiTenantCopyContext context, MultiTenantCloneable<T> entity, Map<String,String> copyHints, EntityDuplicateModifier... modifiers) Create a production duplicate of the entity specified in the params.
boolean	validate(Class<?> entityClass, Long id) Validate whether or not this feature is enabled and whether or not the passed entity params are valid for duplication.
boolean	validate(Object entity) Validate whether or not this feature is enabled and whether or not the passed entity params are valid for duplication.

Method Detail

validate

boolean validate(Class<?> entityClass,
                 Long id)

Validate whether or not this feature is enabled and whether or not the passed entity params are valid for duplication.

Parameters:

entityClass -

id -

Returns:

validate

boolean validate(Object entity)

Validate whether or not this feature is enabled and whether or not the passed entity params are valid for duplication.

Parameters:

entity -

Returns:

copy

<T> T copy(Class<T> entityClass,
           Long id,
           Map<String,String> copyHints,
           EntityDuplicateModifier... modifiers)

Create a production duplicate of the entity specified in the params. The is the most oft used copy method.

Type Parameters:

T - the entity type

Parameters:

entityClass - the class for the entity

id - the primary key

copyHints - hints used to fine tune copying - generally support for hints is included in MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) implementations.

modifiers - list of modifications to perform to the resulting duplicate prior to persistence

Returns:

the duplicated entity

copy

<T> T copy(MultiTenantCopyContext context,
           MultiTenantCloneable<T> entity,
           Map<String,String> copyHints,
           EntityDuplicateModifier... modifiers)

Create a production duplicate of the entity specified in the params. The is the least oft used copy method.

Type Parameters:

T - the entity type

Parameters:

context - prepopulated copy context that is setup for catalog and/or site

entity - the instance to duplicate

copyHints - hints used to fine tune copying - generally support for hints is included in MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) implementations.

modifiers - list of modifications to perform to the resulting duplicate prior to persistence

Returns:

the duplicated entity