com.broadleafcommerce.tenant.service.util

Interface MultiTenantPropagationUtil

All Known Implementing Classes:

MultiTenantPropagationUtilImpl

public interface MultiTenantPropagationUtil

Make determinations regarding propagation behavior given a catalog.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
String	constructSandboxNameForCurrentCatalog(org.broadleafcommerce.common.site.domain.Catalog currentCatalog) For a catalog, determine if it belongs to a standard site and of type MultiTenantSiteCatalog.getPropagationMode() SANDBOX.
String	getDefaultDraftImportSandboxColor()
String	getDefaultDraftImportSandboxName()
org.broadleafcommerce.common.util.Tuple<Class<?>,Long>	getPersistencePackageEntityIdentification(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, javax.persistence.EntityManager em) Retrieve the relevant entity classname and id information from a PersistencePackage.
boolean	isProductionPropagationMode(org.broadleafcommerce.common.site.domain.Catalog currentCatalog) For a catalog, determine if it belongs to a standard site, and if so, whether or not the MultiTenantSiteCatalog.getPropagationMode() is of the type PRODUCTION.
boolean	isPropagationRequired(org.broadleafcommerce.common.site.domain.Catalog currentCatalog) For a catalog, determine if it belongs to a standard site, and if so, whether or not the MultiTenantSiteCatalog.getMutabilityType() is of the type SYNCED_COPY, which requires propagation.
boolean	isPropagationRequired(Object entity) For a entity, determine if it is catalog discriminated and belongs to a standard site, and if so, whether or not the MultiTenantSiteCatalog.getMutabilityType() is of the type SYNCED_COPY, which requires propagation.

Method Detail

isPropagationRequired

boolean isPropagationRequired(org.broadleafcommerce.common.site.domain.Catalog currentCatalog)

For a catalog, determine if it belongs to a standard site, and if so, whether or not the MultiTenantSiteCatalog.getMutabilityType() is of the type SYNCED_COPY, which requires propagation.

Parameters:

currentCatalog -

Returns:

isPropagationRequired

boolean isPropagationRequired(Object entity)

For a entity, determine if it is catalog discriminated and belongs to a standard site, and if so, whether or not the MultiTenantSiteCatalog.getMutabilityType() is of the type SYNCED_COPY, which requires propagation.

Parameters:

entity -

Returns:

isProductionPropagationMode

boolean isProductionPropagationMode(org.broadleafcommerce.common.site.domain.Catalog currentCatalog)

For a catalog, determine if it belongs to a standard site, and if so, whether or not the MultiTenantSiteCatalog.getPropagationMode() is of the type PRODUCTION. This type of propagation updates the production record (rather than creating a sandbox version) in the target catalog.

Parameters:

currentCatalog -

Returns:

constructSandboxNameForCurrentCatalog

String constructSandboxNameForCurrentCatalog(org.broadleafcommerce.common.site.domain.Catalog currentCatalog)

For a catalog, determine if it belongs to a standard site and of type MultiTenantSiteCatalog.getPropagationMode() SANDBOX. If so, then return the configured sandbox name, otherwise return the configured default name.

Parameters:

currentCatalog -

Returns:

getDefaultDraftImportSandboxName

String getDefaultDraftImportSandboxName()

getDefaultDraftImportSandboxColor

String getDefaultDraftImportSandboxColor()

getPersistencePackageEntityIdentification

org.broadleafcommerce.common.util.Tuple<Class<?>,Long> getPersistencePackageEntityIdentification(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                                                 javax.persistence.EntityManager em)

Retrieve the relevant entity classname and id information from a PersistencePackage. This represents the backing persisted entity represented in the PersistencePackage.

Parameters:

persistencePackage -

em -

Returns: