com.broadleafcommerce.tenant.admin.handler

Class MultiTenantStandardSiteContextSiteCatalogXrefCustomPersistenceHandler

java.lang.Object

org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

com.broadleafcommerce.tenant.admin.handler.MultiTenantStandardSiteContextSiteCatalogXrefCustomPersistenceHandler

All Implemented Interfaces:

org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler, org.springframework.core.Ordered

public class MultiTenantStandardSiteContextSiteCatalogXrefCustomPersistenceHandler
extends org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Handle SiteCatalogXref entries for standard site configuration. This is primarily to allow creation of arbitrary catalogs and to allow updating status (i.e. TargetStatusType) on catalogs assigned to the standard site. This handler only applies to a standard site configuring itself.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected DerivedCatalogPropagationEventConsumer	derivedCatalogPropagationEventConsumer
protected org.broadleafcommerce.openadmin.server.service.persistence.validation.EntityValidatorService	entityValidatorService
protected static org.apache.commons.logging.Log	LOG
protected MultiTenantDao	multiTenantDao
protected MultiTenantService	multiTenantService
protected org.broadleafcommerce.common.site.service.SiteService	siteService
protected com.broadleafcommerce.jobsevents.service.SystemEventSender	systemEventSender

Fields inherited from interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

DEFAULT_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MultiTenantStandardSiteContextSiteCatalogXrefCustomPersistenceHandler()

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.openadmin.dto.Entity	add(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper) Adds a new, arbitrary catalog to the standard site
protected void	addAdditionalFields(Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties) Add a fully articulated, artificial field for catalog name
protected void	assignCatalogNameFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)
protected void	assignNonTempStatusFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto) Don't fetch catalog that are still in a incomplete status (e.g.
protected void	assignSiteFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto) Only fetch catalogs assigned to the current context site
protected void	assignVisibilityFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto) Only fetch assigned visible catalogs.
Boolean	canHandleAdd(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleFetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleInspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleUpdate(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.dto.DynamicResultSet	fetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper) Automatically retrieve the status information and manually retrieve the catalog name information
protected void	filterFields(org.broadleafcommerce.openadmin.dto.PersistencePackage pp, Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties) Remove unused fields at the standard site level
org.broadleafcommerce.openadmin.dto.DynamicResultSet	inspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.InspectHelper helper) Strong arm the inspect to only display the catalog name and status information
protected Boolean	isQualifiedForType(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage) Is this handler qualified for the type defined in the persistence package
protected Boolean	isStandardSite() Is the current context site a standard site
void	setEntityValidatorService(org.broadleafcommerce.openadmin.server.service.persistence.validation.EntityValidatorService entityValidatorService)
org.broadleafcommerce.openadmin.dto.Entity	update(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper) Always allow the status to be updated.
protected void	validate(org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper, org.broadleafcommerce.common.site.domain.Catalog catalog, org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.PersistencePerspective persistencePerspective, org.broadleafcommerce.openadmin.dto.Entity siteCatalogXref)

Methods inherited from class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleRemove, getClassForName, getMetadata, getOrder, getPolymorphicClasses, getResultSet, isAdornedListOperation, isAssignableFrom, isBasicOperation, isMapOperation, meetsCustomCriteria, remove, willHandleSecurity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

siteService

protected org.broadleafcommerce.common.site.service.SiteService siteService

multiTenantService

protected MultiTenantService multiTenantService

systemEventSender

protected com.broadleafcommerce.jobsevents.service.SystemEventSender systemEventSender

derivedCatalogPropagationEventConsumer

protected DerivedCatalogPropagationEventConsumer derivedCatalogPropagationEventConsumer

multiTenantDao

protected MultiTenantDao multiTenantDao

entityValidatorService

protected org.broadleafcommerce.openadmin.server.service.persistence.validation.EntityValidatorService entityValidatorService

Constructor Detail

MultiTenantStandardSiteContextSiteCatalogXrefCustomPersistenceHandler

public MultiTenantStandardSiteContextSiteCatalogXrefCustomPersistenceHandler()

Method Detail

setEntityValidatorService

@Autowired
 @Qualifier(value="blEntityValidatorService")
public void setEntityValidatorService(org.broadleafcommerce.openadmin.server.service.persistence.validation.EntityValidatorService entityValidatorService)

canHandleInspect

public Boolean canHandleInspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleInspect in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleInspect in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleAdd

public Boolean canHandleAdd(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleAdd in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleAdd in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleUpdate

public Boolean canHandleUpdate(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleUpdate in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleUpdate in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleFetch

public Boolean canHandleFetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleFetch in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleFetch in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

inspect

public org.broadleafcommerce.openadmin.dto.DynamicResultSet inspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                    org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                    org.broadleafcommerce.openadmin.server.service.persistence.module.InspectHelper helper)
                                                             throws org.broadleafcommerce.common.exception.ServiceException

Strong arm the inspect to only display the catalog name and status information

Specified by:

inspect in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

inspect in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Parameters:

persistencePackage -

dynamicEntityDao -

helper -

Returns:

Throws:

org.broadleafcommerce.common.exception.ServiceException

fetch

public org.broadleafcommerce.openadmin.dto.DynamicResultSet fetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                  org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto,
                                                                  org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                  org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                           throws org.broadleafcommerce.common.exception.ServiceException

Automatically retrieve the status information and manually retrieve the catalog name information

Specified by:

fetch in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

fetch in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Parameters:

persistencePackage -

cto -

dynamicEntityDao -

helper -

Returns:

Throws:

org.broadleafcommerce.common.exception.ServiceException

add

public org.broadleafcommerce.openadmin.dto.Entity add(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                      org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                      org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                               throws org.broadleafcommerce.common.exception.ServiceException

Adds a new, arbitrary catalog to the standard site

Specified by:

add in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

add in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Parameters:

persistencePackage - the user submitted data

dynamicEntityDao - persistence and entity metadata discovery

helper - useful tools for field population

Returns:

the populated entity data

Throws:

org.broadleafcommerce.common.exception.ServiceException - problem during persistence

See Also:

for user security validation and field validation

update

public org.broadleafcommerce.openadmin.dto.Entity update(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                         org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                         org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                  throws org.broadleafcommerce.common.exception.ServiceException

Always allow the status to be updated. The catalog name will be conditionally allowed for update based on StandardSiteAssignedCatalogRowSecurityProvider and StandardSiteAssignedCatalogEntityFormModifier

Specified by:

update in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

update in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Parameters:

persistencePackage -

dynamicEntityDao -

helper -

Returns:

Throws:

org.broadleafcommerce.common.exception.ServiceException

assignNonTempStatusFilterMapping

protected void assignNonTempStatusFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)

Don't fetch catalog that are still in a incomplete status (e.g. syncing)

Parameters:

cto -

assignSiteFilterMapping

protected void assignSiteFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)

Only fetch catalogs assigned to the current context site

Parameters:

cto -

assignVisibilityFilterMapping

protected void assignVisibilityFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)

Only fetch assigned visible catalogs. This setting is controlled at the global level.

Parameters:

cto -

assignCatalogNameFilterMapping

protected void assignCatalogNameFilterMapping(org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)

filterFields

protected void filterFields(org.broadleafcommerce.openadmin.dto.PersistencePackage pp,
                            Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)

Remove unused fields at the standard site level

Parameters:

pp -

allMergedProperties -

addAdditionalFields

protected void addAdditionalFields(Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)

Add a fully articulated, artificial field for catalog name

Parameters:

allMergedProperties -

isStandardSite

protected Boolean isStandardSite()

Is the current context site a standard site

Returns:

isQualifiedForType

protected Boolean isQualifiedForType(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Is this handler qualified for the type defined in the persistence package

Parameters:

persistencePackage -

Returns:

validate

protected void validate(org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper,
                        org.broadleafcommerce.common.site.domain.Catalog catalog,
                        org.broadleafcommerce.openadmin.dto.Entity entity,
                        org.broadleafcommerce.openadmin.dto.PersistencePerspective persistencePerspective,
                        org.broadleafcommerce.openadmin.dto.Entity siteCatalogXref)