com.broadleafcommerce.enterprise.workflow.admin.service

Class AbstractPersistenceManagerAware

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.service.AbstractWorkflowSupport

com.broadleafcommerce.enterprise.workflow.admin.service.AbstractPersistenceManagerAware

All Implemented Interfaces:

PersistenceManagerAware, WorkflowSupport

Direct Known Subclasses:

AbstractSolrCacheInvalidationProducer, AbstractWorkflowManager, AbstractWorkflowPersistenceModule, CommonCacheInvalidationProducerImpl, DefaultAdornedTargetReconstituteForAddHandler, DefaultBasicReconstituteForAddHandler, DefaultMapReconstituteForAddHandler, EntityItemServiceImpl, ProductToSkuTranslationReconstituteForAddHandler, RuleBuilderReconstituteForAddHandler, SkuReconstituteForAddHandler, TranslationReconstituteForAddHandler, WorkflowAuditServiceImpl

public abstract class AbstractPersistenceManagerAware
extends AbstractWorkflowSupport
implements PersistenceManagerAware

Base class providing a generally useful implementation of the PersistenceManagerAware interface. Classes wishing to inherit access to these object and helper method should extend this class.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected SandBoxHelperImpl	sandBoxHelper

Constructor Summary

Constructors

Constructor and Description
AbstractPersistenceManagerAware()

Method Summary

Modifier and Type	Method and Description
Class<?>	getCeilingImpl(org.broadleafcommerce.openadmin.dto.Entity entity) Retrieve the class representing the top of the inheritance hierarchy for the Entity instance.
Class<?>	getCeilingImpl(String className) Retrieve the class representing the top of the inheritance hierarchy for the entity class.
org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager	getFieldManager() Retrieve the currently active FieldManager.
Serializable	getIdentifier(Object temp) Retrieve the primary key value for the entity class instance.
String	getIdProperty(Class<?> type) Retrieve the primary key property for the passed in entity type.
org.hibernate.type.Type	getIdType(Class<?> type) Retrieve the Type for the passed in class.
org.broadleafcommerce.common.sandbox.SandBoxHelper.OriginalIdResponse	getOriginalId(Class<?> type, Long id) Return the original id for the requested id.
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager	getPersistenceManager() Retrieve the currently active PersistenceManager.
Long	getProdSandBoxVersionId(Class<?> type, Long id)
org.broadleafcommerce.common.sandbox.SandBoxHelper.OriginalIdResponse	getProductionOriginalId(Class<?> type, Long id) Return the original id for the requested id as if this was a production request.
Long	getSandBoxVersionId(Class<?> type, Long id) Retrieve the primary key value of the sandbox version (clone) for the passed in type and id.
<T> T	load(Class<T> entityClass, Object id) Load an entity instance
List<Long>	mergeCloneIds(Class<?> type, Long... originalIds) Retrieve a list of values that includes the the original ids passed in and any sandbox versions of those ids, if available.

Methods inherited from class com.broadleafcommerce.enterprise.workflow.admin.service.AbstractWorkflowSupport

getGroupNameGeneralization

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.enterprise.workflow.admin.service.WorkflowSupport

getGroupNameGeneralization

Field Detail

sandBoxHelper

protected SandBoxHelperImpl sandBoxHelper

Constructor Detail

AbstractPersistenceManagerAware

public AbstractPersistenceManagerAware()

Method Detail

getPersistenceManager

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager getPersistenceManager()

Description copied from interface: PersistenceManagerAware

Retrieve the currently active PersistenceManager. This is useful for obtaining access to persistence store functionality, such as find, fetch, add, update and remove.

Specified by:

getPersistenceManager in interface PersistenceManagerAware

Returns:

the PersistenceManager

getFieldManager

public org.broadleafcommerce.openadmin.server.service.persistence.module.FieldManager getFieldManager()

Description copied from interface: PersistenceManagerAware

Retrieve the currently active FieldManager. This is useful for providing easy access to field values on an entity. The FieldManager is smart enough to understand common bean property syntax and can walk complicated object trees.

Specified by:

getFieldManager in interface PersistenceManagerAware

Returns:

the FieldManager

getIdProperty

public String getIdProperty(Class<?> type)

Description copied from interface: PersistenceManagerAware

Retrieve the primary key property for the passed in entity type. Presumably, the type parameter represents an entity registered with JPA.

Specified by:

getIdProperty in interface PersistenceManagerAware

Parameters:

type - the entity type

Returns:

the name of the primary key property

getIdType

public org.hibernate.type.Type getIdType(Class<?> type)

Description copied from interface: PersistenceManagerAware

Retrieve the Type for the passed in class.

Specified by:

getIdType in interface PersistenceManagerAware

Parameters:

type - the class to test

Returns:

the Hibernate type

load

public <T> T load(Class<T> entityClass,
                  Object id)

Description copied from interface: PersistenceManagerAware

Load an entity instance

Specified by:

load in interface PersistenceManagerAware

Type Parameters:

T - the entity type

Parameters:

entityClass - the entity type

id - the entity primary key value

Returns:

the entity instance

getSandBoxVersionId

public Long getSandBoxVersionId(Class<?> type,
                                Long id)

Description copied from interface: PersistenceManagerAware

Retrieve the primary key value of the sandbox version (clone) for the passed in type and id. Will return null if a sandbox version is not available.

Specified by:

getSandBoxVersionId in interface PersistenceManagerAware

Parameters:

type - the entity type

id - the entity primary key value

Returns:

the sandbox version, or null

getProdSandBoxVersionId

public Long getProdSandBoxVersionId(Class<?> type,
                                    Long id)

Specified by:

getProdSandBoxVersionId in interface PersistenceManagerAware

getOriginalId

public org.broadleafcommerce.common.sandbox.SandBoxHelper.OriginalIdResponse getOriginalId(Class<?> type,
                                                                                           Long id)

Description copied from interface: PersistenceManagerAware

Return the original id for the requested id. Will return the passed in id if the type is not sandboxable. Will return null if the passed in id is not a sandbox record, or if it's a sandbox add.

Specified by:

getOriginalId in interface PersistenceManagerAware

Parameters:

type - the type of the entity in question

id - the id to check

Returns:

the original id for the requested sandbox id

getProductionOriginalId

public org.broadleafcommerce.common.sandbox.SandBoxHelper.OriginalIdResponse getProductionOriginalId(Class<?> type,
                                                                                                     Long id)

Description copied from interface: PersistenceManagerAware

Return the original id for the requested id as if this was a production request. The id passed in should be a production id. You will receive back the original id for this production id. The only time this makes sense is when the passed in id is for the production record from a standard site. This method is useful when you want the template record id for a standard site production id while in a sandbox context.

Specified by:

getProductionOriginalId in interface PersistenceManagerAware

Returns:

mergeCloneIds

public List<Long> mergeCloneIds(Class<?> type,
                                Long... originalIds)

Description copied from interface: PersistenceManagerAware

Retrieve a list of values that includes the the original ids passed in and any sandbox versions of those ids, if available. This is useful for some queries that require search values for both the original id and the sandbox id.

Specified by:

mergeCloneIds in interface PersistenceManagerAware

Parameters:

type - the type of the entity in question

originalIds - one or more ids values for which sandbox versions should be included

Returns:

the merged id list

getCeilingImpl

public Class<?> getCeilingImpl(org.broadleafcommerce.openadmin.dto.Entity entity)

Description copied from interface: PersistenceManagerAware

Retrieve the class representing the top of the inheritance hierarchy for the Entity instance.

Specified by:

getCeilingImpl in interface PersistenceManagerAware

Parameters:

entity - the Entity instance

Returns:

the top level class

getCeilingImpl

public Class<?> getCeilingImpl(String className)

Description copied from interface: PersistenceManagerAware

Retrieve the class representing the top of the inheritance hierarchy for the entity class.

Specified by:

getCeilingImpl in interface PersistenceManagerAware

Parameters:

className - the name of the entity class

Returns:

the top level class

getIdentifier

public Serializable getIdentifier(Object temp)

Description copied from interface: PersistenceManagerAware

Retrieve the primary key value for the entity class instance.

Specified by:

getIdentifier in interface PersistenceManagerAware

Parameters:

temp - the entity class instance

Returns:

the primary key value