Package org.broadleafcommerce.cms.admin.server.handler

Class PageTemplateCustomPersistenceHandler

java.lang.Object

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

org.broadleafcommerce.cms.admin.server.handler.PageTemplateCustomPersistenceHandler

All Implemented Interfaces:

CustomPersistenceHandler, DynamicEntityRetriever, org.springframework.core.Ordered

@Component("blPageTemplateCustomPersistenceHandler")
public class PageTemplateCustomPersistenceHandler
extends CustomPersistenceHandlerAdapter
implements DynamicEntityRetriever

Created by jfischer

Field Summary

Fields

Modifier and Type	Field	Description
protected DynamicFieldPersistenceHandlerHelper	dynamicFieldUtil
protected jakarta.persistence.EntityManager	em
protected PageService	pageService
protected SandBoxService	sandBoxService

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	Description
PageTemplateCustomPersistenceHandler()

Method Summary

Modifier and Type	Method	Description
Entity	add(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, RecordHelper helper)
protected Entity	addOrUpdate(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, RecordHelper helper)
Boolean	canHandleAdd(PersistencePackage persistencePackage)	Is this persistence handler capable of dealing with an add request from the admin
Boolean	canHandleFetch(PersistencePackage persistencePackage)	Is this persistence handler capable of dealing with an fetch request from the admin
Boolean	canHandleInspect(PersistencePackage persistencePackage)	Is this persistence handler capable of dealing with an inspect request from the admin
Boolean	canHandleRemove(PersistencePackage persistencePackage)	Is this persistence handler capable of dealing with a remove request from the admin
Boolean	canHandleUpdate(PersistencePackage persistencePackage)	Is this persistence handler capable of dealing with an update request from the admin
DynamicResultSet	fetch(PersistencePackage persistencePackage, CriteriaTransferObject cto, DynamicEntityDao dynamicEntityDao, RecordHelper helper)
Entity	fetchDynamicEntity(Serializable root, List<String> dirtyFields, boolean includeId)
Entity	fetchEntityBasedOnId(String pageId, List<String> dirtyFields)
String	getFieldContainerClassName()
protected List<FieldGroup>	getFieldGroups(Page page, PageTemplate template)
protected List<FieldGroup>	getFieldGroups(PersistencePackage pp, DynamicEntityDao dynamicEntityDao)
protected SandBox	getSandBox()
DynamicResultSet	inspect(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, InspectHelper helper)
protected void	populateFKLookupValues(DynamicEntityDao dynamicEntityDao, Entity entity)	Some of the values in this entity might be foreign key lookups.
protected void	processFieldGroups(List<String> dirtyFields, Map<String,PageField> pageFieldMap, List<Property> propertiesList, List<FieldGroup> fieldGroups)
protected void	processIncludeId(boolean includeId, Page page, List<Property> propertiesList)
Entity	update(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, RecordHelper helper)

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

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 Details

pageService

protected PageService pageService

sandBoxService

protected SandBoxService sandBoxService

dynamicFieldUtil

protected DynamicFieldPersistenceHandlerHelper dynamicFieldUtil

em

protected jakarta.persistence.EntityManager em

Constructor Details

PageTemplateCustomPersistenceHandler

public PageTemplateCustomPersistenceHandler()

Method Details

canHandleFetch

public Boolean canHandleFetch(PersistencePackage persistencePackage)

Description copied from interface: CustomPersistenceHandler

Is this persistence handler capable of dealing with an fetch request from the admin

Specified by:

canHandleFetch in interface CustomPersistenceHandler

Overrides:

canHandleFetch in class CustomPersistenceHandlerAdapter

Parameters:

persistencePackage - details about the fetch operation

Returns:

whether or not this handler supports fetches

canHandleAdd

public Boolean canHandleAdd(PersistencePackage persistencePackage)

Description copied from interface: CustomPersistenceHandler

Is this persistence handler capable of dealing with an add request from the admin

Specified by:

canHandleAdd in interface CustomPersistenceHandler

Overrides:

canHandleAdd in class CustomPersistenceHandlerAdapter

Parameters:

persistencePackage - details about the add operation

Returns:

whether or not this handler supports adds

canHandleInspect

public Boolean canHandleInspect(PersistencePackage persistencePackage)

Description copied from interface: CustomPersistenceHandler

Is this persistence handler capable of dealing with an inspect request from the admin

Specified by:

canHandleInspect in interface CustomPersistenceHandler

Overrides:

canHandleInspect in class CustomPersistenceHandlerAdapter

Parameters:

persistencePackage - details about the inspect operation

Returns:

whether or not this handler supports inspects

canHandleRemove

public Boolean canHandleRemove(PersistencePackage persistencePackage)

Description copied from interface: CustomPersistenceHandler

Is this persistence handler capable of dealing with a remove request from the admin

Specified by:

canHandleRemove in interface CustomPersistenceHandler

Overrides:

canHandleRemove in class CustomPersistenceHandlerAdapter

Parameters:

persistencePackage - details about the remove operation

Returns:

whether or not this handler supports remove

canHandleUpdate

public Boolean canHandleUpdate(PersistencePackage persistencePackage)

Description copied from interface: CustomPersistenceHandler

Is this persistence handler capable of dealing with an update request from the admin

Specified by:

canHandleUpdate in interface CustomPersistenceHandler

Overrides:

canHandleUpdate in class CustomPersistenceHandlerAdapter

Parameters:

persistencePackage - details about the update operation

Returns:

whether or not this handler supports updatess

getSandBox

protected SandBox getSandBox()

getFieldGroups

protected List<FieldGroup> getFieldGroups(Page page,
 PageTemplate template)

getFieldGroups

protected List<FieldGroup> getFieldGroups(PersistencePackage pp,
 DynamicEntityDao dynamicEntityDao)

inspect

public DynamicResultSet inspect(PersistencePackage persistencePackage,
 DynamicEntityDao dynamicEntityDao,
 InspectHelper helper)
                         throws ServiceException

Specified by:

inspect in interface CustomPersistenceHandler

Overrides:

inspect in class CustomPersistenceHandlerAdapter

Throws:

ServiceException

fetch

public DynamicResultSet fetch(PersistencePackage persistencePackage,
 CriteriaTransferObject cto,
 DynamicEntityDao dynamicEntityDao,
 RecordHelper helper)
                       throws ServiceException

Specified by:

fetch in interface CustomPersistenceHandler

Overrides:

fetch in class CustomPersistenceHandlerAdapter

Throws:

ServiceException

populateFKLookupValues

protected void populateFKLookupValues(DynamicEntityDao dynamicEntityDao,
 Entity entity)
                               throws ClassNotFoundException

Some of the values in this entity might be foreign key lookups. In this case, we need to set the display value appropriately

Parameters:

dynamicEntityDao -

entity -

Throws:

ClassNotFoundException

getFieldContainerClassName

public String getFieldContainerClassName()

Specified by:

getFieldContainerClassName in interface DynamicEntityRetriever

fetchEntityBasedOnId

public Entity fetchEntityBasedOnId(String pageId,
 List<String> dirtyFields)
                            throws Exception

Specified by:

fetchEntityBasedOnId in interface DynamicEntityRetriever

Throws:

Exception

fetchDynamicEntity

public Entity fetchDynamicEntity(Serializable root,
 List<String> dirtyFields,
 boolean includeId)
                          throws Exception

Specified by:

fetchDynamicEntity in interface DynamicEntityRetriever

Throws:

Exception

processFieldGroups

protected void processFieldGroups(List<String> dirtyFields,
 Map<String,PageField> pageFieldMap,
 List<Property> propertiesList,
 List<FieldGroup> fieldGroups)

processIncludeId

protected void processIncludeId(boolean includeId,
 Page page,
 List<Property> propertiesList)

update

public Entity update(PersistencePackage persistencePackage,
 DynamicEntityDao dynamicEntityDao,
 RecordHelper helper)
              throws ServiceException

Specified by:

update in interface CustomPersistenceHandler

Overrides:

update in class CustomPersistenceHandlerAdapter

Throws:

ServiceException

add

public Entity add(PersistencePackage persistencePackage,
 DynamicEntityDao dynamicEntityDao,
 RecordHelper helper)
           throws ServiceException

Specified by:

add in interface CustomPersistenceHandler

Overrides:

add in class CustomPersistenceHandlerAdapter

Throws:

ServiceException

addOrUpdate

protected Entity addOrUpdate(PersistencePackage persistencePackage,
 DynamicEntityDao dynamicEntityDao,
 RecordHelper helper)
                      throws ServiceException

Throws:

ServiceException