Package org.broadleafcommerce.openadmin.server.service.handler

Class CustomPersistenceHandlerAdapter

java.lang.Object

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

All Implemented Interfaces:

CustomPersistenceHandler, org.springframework.core.Ordered

Direct Known Subclasses:

AdminPermissionCustomPersistenceHandler, AdminUserCustomPersistenceHandler, CategoryCustomPersistenceHandler, ChildCategoriesCustomPersistenceHandler, ClassCustomPersistenceHandlerAdapter, CustomerCustomPersistenceHandler, CustomerPasswordCustomPersistenceHandler, FieldOnlyPropertiesCustomPersistenceHandler, IndexFieldCustomPersistenceHandler, ISOCountryPersistenceHandler, PageTemplateCustomPersistenceHandler, ProductCustomPersistenceHandler, ProductOptionsCustomPersistenceHandler, ProductOptionValuesCustomPersistenceHandler, SearchFacetCustomPersistenceHandler, SearchFacetRangeCustomPersistenceHandler, SkuBundleItemCustomPersistenceHandler, SkuCustomPersistenceHandler, SkuLookupByProductCustomPersistenceHandler, StructuredContentTypeCustomPersistenceHandler, SystemPropertyCustomPersistenceHandler, TimeDTOCustomPersistenceHandler, TranslationCustomPersistenceHandler

public class CustomPersistenceHandlerAdapter
extends Object
implements CustomPersistenceHandler

Convenience class for those CustomPersistenceHandler implementations that do not wish to implement all the methods of the interface.

Author:

Jeff Fischer

Field Summary

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
CustomPersistenceHandlerAdapter()

Method Summary

Modifier and Type	Method	Description
Entity	add(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)
protected Class	getClassForName(String ceilingEntityFullyQualifiedClassname)
protected Map<String,FieldMetadata>	getMetadata(PersistencePackage persistencePackage, InspectHelper helper)	This is a helper method that can be invoked as a first step in a custom inspect phase
int	getOrder()
protected String[]	getPolymorphicClasses(Class<?> clazz, jakarta.persistence.EntityManager em, boolean useCache)
protected DynamicResultSet	getResultSet(PersistencePackage persistencePackage, InspectHelper helper, Map<String,FieldMetadata> metadata)	This is a helper method that can be invoked as the last step in a custom inspect phase.
DynamicResultSet	inspect(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, InspectHelper helper)
protected boolean	isAdornedListOperation(PersistencePackage pkg)
protected boolean	isAssignableFrom(String ceilingEntityFullyQualifiedClassname, Class targetClass)
protected boolean	isBasicOperation(PersistencePackage pkg)
protected boolean	isMapOperation(PersistencePackage pkg)
protected boolean	meetsCustomCriteria(PersistencePackage pkg, String[] customCriteria)
void	remove(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, RecordHelper helper)
Entity	update(PersistencePackage persistencePackage, DynamicEntityDao dynamicEntityDao, RecordHelper helper)
Boolean	willHandleSecurity(PersistencePackage persistencePackage)

Methods inherited from class java.lang.Object

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

Constructor Details

CustomPersistenceHandlerAdapter

public CustomPersistenceHandlerAdapter()

Method Details

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

Parameters:

persistencePackage - details about the inspect operation

Returns:

whether or not this handler supports inspects

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

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

Parameters:

persistencePackage - details about the add operation

Returns:

whether or not this handler supports adds

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

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

Parameters:

persistencePackage - details about the update operation

Returns:

whether or not this handler supports updatess

inspect

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

Specified by:

inspect in interface CustomPersistenceHandler

Throws:

ServiceException

fetch

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

Specified by:

fetch in interface CustomPersistenceHandler

Throws:

ServiceException

add

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

Specified by:

add in interface CustomPersistenceHandler

Throws:

ServiceException

remove

public void remove(PersistencePackage persistencePackage,
 DynamicEntityDao dynamicEntityDao,
 RecordHelper helper)
            throws ServiceException

Specified by:

remove in interface CustomPersistenceHandler

Throws:

ServiceException

update

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

Specified by:

update in interface CustomPersistenceHandler

Throws:

ServiceException

willHandleSecurity

public Boolean willHandleSecurity(PersistencePackage persistencePackage)

Specified by:

willHandleSecurity in interface CustomPersistenceHandler

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

getMetadata

protected Map<String,FieldMetadata> getMetadata(PersistencePackage persistencePackage,
 InspectHelper helper)
                                         throws ServiceException

This is a helper method that can be invoked as a first step in a custom inspect phase

Throws:

ServiceException

getResultSet

protected DynamicResultSet getResultSet(PersistencePackage persistencePackage,
 InspectHelper helper,
 Map<String,FieldMetadata> metadata)
                                 throws ServiceException

This is a helper method that can be invoked as the last step in a custom inspect phase. It will assemble the appropriate DynamicResultSet from the given parameters.

Throws:

ServiceException

getPolymorphicClasses

protected String[] getPolymorphicClasses(Class<?> clazz,
 jakarta.persistence.EntityManager em,
 boolean useCache)

getClassForName

protected Class getClassForName(String ceilingEntityFullyQualifiedClassname)

isAssignableFrom

protected boolean isAssignableFrom(String ceilingEntityFullyQualifiedClassname,
 Class targetClass)

meetsCustomCriteria

protected boolean meetsCustomCriteria(PersistencePackage pkg,
 String[] customCriteria)

isBasicOperation

protected boolean isBasicOperation(PersistencePackage pkg)

isMapOperation

protected boolean isMapOperation(PersistencePackage pkg)

isAdornedListOperation

protected boolean isAdornedListOperation(PersistencePackage pkg)