org.broadleafcommerce.openadmin.server.service

Class AdminEntityServiceImpl

java.lang.Object

org.broadleafcommerce.openadmin.server.service.AdminEntityServiceImpl

All Implemented Interfaces:

AdminEntityService

@Service(value="blAdminEntityService")
public class AdminEntityServiceImpl
extends Object
implements AdminEntityService

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
protected DynamicDaoHelper	dynamicDaoHelper
protected javax.persistence.EntityManager	em
protected EntityConfiguration	entityConfiguration
protected GenericEntityDao	genericEntityDao
protected static org.apache.commons.logging.Log	LOG
protected PersistencePackageFactory	persistencePackageFactory
protected DynamicEntityService	service

Constructor Summary

Constructors

Constructor and Description
AdminEntityServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
PersistenceResponse	add(PersistencePackageRequest request) Thin layer on top of DynamicEntityService.add(org.broadleafcommerce.openadmin.dto.PersistencePackage) that swallows all ValidationExceptions that could be thrown and still just returns a PersistenceResponse with the Entity that failed validation.
PersistenceResponse	add(PersistencePackageRequest request, boolean transactional) Works the same as AdminEntityService.add(PersistencePackageRequest) but you can optionally invoke the transactional version of DynamicEntityRemoteService.add(org.broadleafcommerce.openadmin.dto.PersistencePackage) in situations where you want to manage the transactions in a parent component
PersistenceResponse	addEntity(EntityForm entityForm, String[] customCriteria, List<SectionCrumb> sectionCrumb) Persists the given entity
PersistenceResponse	addSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, List<SectionCrumb> sectionCrumbs) Adds an item into the specified collection
protected void	ensureEntityMarkedAsValidationFailure(ValidationException e, PersistencePackageRequest originalRequest) Should be invoked when a ValidationException is thrown to verify that the Entity contained within the given originalRequest has a validationFailure = true
PersistenceResponse	fetch(PersistencePackageRequest request) Thin layer on top of DynamicEntityService.fetch(org.broadleafcommerce.openadmin.dto.PersistencePackage, org.broadleafcommerce.openadmin.dto.CriteriaTransferObject).
PersistenceResponse	getAdvancedCollectionRecord(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId) Gets an Entity representing a specific collection item
PersistenceResponse	getAdvancedCollectionRecord(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId, String[] customCriteria) Gets an Entity representing a specific collection item
PersistenceResponse	getClassMetadata(PersistencePackageRequest request) Returns class metadata for the given request object
String	getContextSpecificRelationshipId(ClassMetadata cmd, Entity entity, String propertyName) Returns the appropriate id to use for the given entity/metadata and prefix when dealing with collections.
protected CriteriaTransferObject	getDefaultCto()
protected int	getDefaultMaxResults()
String	getForeignEntityName(String owningClass, String id) For the given class (which could be an interface) and id, finds the AdminMainEntity value for the foreign entity
String	getIdProperty(ClassMetadata cmd) Returns the name of the property in this ClassMetadata that has field type set to SupportedFieldType.ID
protected List<Property>	getPropertiesFromEntityForm(EntityForm entityForm)
PersistenceResponse	getRecord(PersistencePackageRequest request, String id, ClassMetadata cmd, boolean isCollectionRequest) Returns a specific record for the given request and primary key id/property
PersistenceResponse	getRecords(PersistencePackageRequest request) Returns the DynamicResultSet containing the total records for the query and the currently fetched Entity[]
Map<String,DynamicResultSet>	getRecordsForAllSubCollections(PersistencePackageRequest ppr, Entity containingEntity, Integer startIndex, Integer maxIndex, List<SectionCrumb> sectionCrumb) overloading containing paging parameters
Map<String,DynamicResultSet>	getRecordsForAllSubCollections(PersistencePackageRequest ppr, Entity containingEntity, List<SectionCrumb> sectionCrumb) Returns all records for all subcollections of the specified request and its primary key
PersistenceResponse	getRecordsForCollection(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, List<SectionCrumb> sectionCrumb) Returns the DynamicResultSet representing the records that belong to the specified collectionProperty for the given containingClass and the primary key for the containingClass
PersistenceResponse	getRecordsForCollection(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, String idValueOverride, List<SectionCrumb> sectionCrumbs) The same as the other getRecordsForCollection method, except that this one expects allow the caller to explicitly set the id value that will be used in the fetch instead of delegating to #getContextSpecificRelationshipId()
Map<String,DynamicResultSet>	getRecordsForSelectedTab(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb, String currentTabName) Returns all records for selected tab of the specified request and its primary key
PersistencePackageRequest	getRequestForEntityForm(EntityForm entityForm, String[] customCriteria, List<SectionCrumb> sectionCrumbs) Gets the PersistencePackageRequest for the passed in EntityForm
PersistenceResponse	inspect(PersistencePackageRequest request) Thin layer on top of DynamicEntityService.inspect(org.broadleafcommerce.openadmin.dto.PersistencePackage)
PersistenceResponse	remove(PersistencePackageRequest request) Thin layer on top of DynamicEntityService.remove(org.broadleafcommerce.openadmin.dto.PersistencePackage)
PersistenceResponse	remove(PersistencePackageRequest request, boolean transactional) Works the same as AdminEntityService.remove(PersistencePackageRequest) but you can optionally invoke the transactional version of DynamicEntityRemoteService.remove(org.broadleafcommerce.openadmin.dto.PersistencePackage) in situations where you want to manage the transactions in a parent component
PersistenceResponse	removeEntity(EntityForm entityForm, String[] customCriteria, List<SectionCrumb> sectionCrumb) Removes the given entity
PersistenceResponse	removeSubCollectionEntity(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String priorKey, List<SectionCrumb> sectionCrumbs) Removes the given item from the specified collection.
PersistenceResponse	removeSubCollectionEntity(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String alternateId, String priorKey, List<SectionCrumb> sectionCrumbs) Removes the given item from the specified collection.
PersistenceResponse	update(PersistencePackageRequest request) Thin layer on top of DynamicEntityService.update(org.broadleafcommerce.openadmin.dto.PersistencePackage)
PersistenceResponse	update(PersistencePackageRequest request, boolean transactional) Works the same as AdminEntityService.update(PersistencePackageRequest) but you can optionally invoke the transactional version of DynamicEntityRemoteService.update(org.broadleafcommerce.openadmin.dto.PersistencePackage) in situations where you want to manage the transactions in a parent component
PersistenceResponse	updateEntity(EntityForm entityForm, String[] customCriteria, List<SectionCrumb> sectionCrumb) Updates the given entity
PersistenceResponse	updateSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, List<SectionCrumb> sectionCrumb) Updates the specified collection item
PersistenceResponse	updateSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, String alternateId, List<SectionCrumb> sectionCrumbs) Updates the specified collection item
protected void	updateTabInfo(CollectionMetadata fmd, ClassMetadata cmd, String tabName, int tabOrder)

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

service

protected DynamicEntityService service

persistencePackageFactory

protected PersistencePackageFactory persistencePackageFactory

em

protected javax.persistence.EntityManager em

entityConfiguration

protected EntityConfiguration entityConfiguration

genericEntityDao

protected GenericEntityDao genericEntityDao

dynamicDaoHelper

protected DynamicDaoHelper dynamicDaoHelper

Constructor Detail

AdminEntityServiceImpl

public AdminEntityServiceImpl()

Method Detail

getClassMetadata

public PersistenceResponse getClassMetadata(PersistencePackageRequest request)
                                     throws ServiceException

Description copied from interface: AdminEntityService

Returns class metadata for the given request object

Specified by:

getClassMetadata in interface AdminEntityService

Returns:

ClassMetadata for the given request

Throws:

ServiceException

getRecords

public PersistenceResponse getRecords(PersistencePackageRequest request)
                               throws ServiceException

Description copied from interface: AdminEntityService

Returns the DynamicResultSet containing the total records for the query and the currently fetched Entity[]

Specified by:

getRecords in interface AdminEntityService

Returns:

DynamicResultSet

Throws:

ServiceException

getRecord

public PersistenceResponse getRecord(PersistencePackageRequest request,
                            String id,
                            ClassMetadata cmd,
                            boolean isCollectionRequest)
                              throws ServiceException

Description copied from interface: AdminEntityService

Returns a specific record for the given request and primary key id/property

Specified by:

getRecord in interface AdminEntityService

isCollectionRequest - whether or not this record request was initiated from a collection on a parent entity

Returns:

the Entity

Throws:

ServiceException

addEntity

public PersistenceResponse addEntity(EntityForm entityForm,
                            String[] customCriteria,
                            List<SectionCrumb> sectionCrumb)
                              throws ServiceException

Description copied from interface: AdminEntityService

Persists the given entity

Specified by:

addEntity in interface AdminEntityService

Returns:

the persisted Entity

Throws:

ServiceException

updateEntity

public PersistenceResponse updateEntity(EntityForm entityForm,
                               String[] customCriteria,
                               List<SectionCrumb> sectionCrumb)
                                 throws ServiceException

Description copied from interface: AdminEntityService

Updates the given entity

Specified by:

updateEntity in interface AdminEntityService

Returns:

the persisted Entity

Throws:

ServiceException

removeEntity

public PersistenceResponse removeEntity(EntityForm entityForm,
                               String[] customCriteria,
                               List<SectionCrumb> sectionCrumb)
                                 throws ServiceException

Description copied from interface: AdminEntityService

Removes the given entity

Specified by:

removeEntity in interface AdminEntityService

Throws:

ServiceException

getPropertiesFromEntityForm

protected List<Property> getPropertiesFromEntityForm(EntityForm entityForm)

getRequestForEntityForm

public PersistencePackageRequest getRequestForEntityForm(EntityForm entityForm,
                                                String[] customCriteria,
                                                List<SectionCrumb> sectionCrumbs)

Description copied from interface: AdminEntityService

Gets the PersistencePackageRequest for the passed in EntityForm

Specified by:

getRequestForEntityForm in interface AdminEntityService

getAdvancedCollectionRecord

public PersistenceResponse getAdvancedCollectionRecord(ClassMetadata containingClassMetadata,
                                              Entity containingEntity,
                                              Property collectionProperty,
                                              String collectionItemId,
                                              List<SectionCrumb> sectionCrumbs,
                                              String alternateId)
                                                throws ServiceException

Description copied from interface: AdminEntityService

Gets an Entity representing a specific collection item

Specified by:

getAdvancedCollectionRecord in interface AdminEntityService

Returns:

the Entity

Throws:

ServiceException

getAdvancedCollectionRecord

public PersistenceResponse getAdvancedCollectionRecord(ClassMetadata containingClassMetadata,
                                              Entity containingEntity,
                                              Property collectionProperty,
                                              String collectionItemId,
                                              List<SectionCrumb> sectionCrumbs,
                                              String alternateId,
                                              String[] customCriteria)
                                                throws ServiceException

Description copied from interface: AdminEntityService

Gets an Entity representing a specific collection item

Specified by:

getAdvancedCollectionRecord in interface AdminEntityService

Returns:

the Entity

Throws:

ServiceException

getRecordsForCollection

public PersistenceResponse getRecordsForCollection(ClassMetadata containingClassMetadata,
                                          Entity containingEntity,
                                          Property collectionProperty,
                                          FilterAndSortCriteria[] fascs,
                                          Integer startIndex,
                                          Integer maxIndex,
                                          List<SectionCrumb> sectionCrumb)
                                            throws ServiceException

Description copied from interface: AdminEntityService

Returns the DynamicResultSet representing the records that belong to the specified collectionProperty for the given containingClass and the primary key for the containingClass

Specified by:

getRecordsForCollection in interface AdminEntityService

Returns:

the DynamicResultSet

Throws:

ServiceException

getRecordsForCollection

public PersistenceResponse getRecordsForCollection(ClassMetadata containingClassMetadata,
                                          Entity containingEntity,
                                          Property collectionProperty,
                                          FilterAndSortCriteria[] fascs,
                                          Integer startIndex,
                                          Integer maxIndex,
                                          String idValueOverride,
                                          List<SectionCrumb> sectionCrumbs)
                                            throws ServiceException

Description copied from interface: AdminEntityService

The same as the other getRecordsForCollection method, except that this one expects allow the caller to explicitly set the id value that will be used in the fetch instead of delegating to #getContextSpecificRelationshipId()

Specified by:

getRecordsForCollection in interface AdminEntityService

Returns:

the PersistenceResponse

Throws:

ServiceException

getRecordsForAllSubCollections

public Map<String,DynamicResultSet> getRecordsForAllSubCollections(PersistencePackageRequest ppr,
                                                          Entity containingEntity,
                                                          Integer startIndex,
                                                          Integer maxIndex,
                                                          List<SectionCrumb> sectionCrumb)
                                                            throws ServiceException

Description copied from interface: AdminEntityService

overloading containing paging parameters

Specified by:

getRecordsForAllSubCollections in interface AdminEntityService

Returns:

Throws:

ServiceException

getRecordsForAllSubCollections

public Map<String,DynamicResultSet> getRecordsForAllSubCollections(PersistencePackageRequest ppr,
                                                          Entity containingEntity,
                                                          List<SectionCrumb> sectionCrumb)
                                                            throws ServiceException

Description copied from interface: AdminEntityService

Returns all records for all subcollections of the specified request and its primary key

Specified by:

getRecordsForAllSubCollections in interface AdminEntityService

Returns:

all Entity[] for all collections for the specified containingClass

Throws:

ServiceException

See Also:

#getRecordsForCollection(ClassMetadata, String, Property)

getRecordsForSelectedTab

public Map<String,DynamicResultSet> getRecordsForSelectedTab(ClassMetadata cmd,
                                                    Entity containingEntity,
                                                    List<SectionCrumb> sectionCrumb,
                                                    String currentTabName)
                                                      throws ServiceException

Description copied from interface: AdminEntityService

Returns all records for selected tab of the specified request and its primary key

Specified by:

getRecordsForSelectedTab in interface AdminEntityService

Returns:

all Entity[] for selected tab for the specified containingClass

Throws:

ServiceException

See Also:

#getRecordsForCollection(ClassMetadata, String, Property)

updateTabInfo

protected void updateTabInfo(CollectionMetadata fmd,
                 ClassMetadata cmd,
                 String tabName,
                 int tabOrder)

addSubCollectionEntity

public PersistenceResponse addSubCollectionEntity(EntityForm entityForm,
                                         ClassMetadata mainMetadata,
                                         Property field,
                                         Entity parentEntity,
                                         List<SectionCrumb> sectionCrumbs)
                                           throws ServiceException,
                                                  ClassNotFoundException

Description copied from interface: AdminEntityService

Adds an item into the specified collection

Specified by:

addSubCollectionEntity in interface AdminEntityService

Returns:

the persisted Entity

Throws:

ServiceException

ClassNotFoundException

updateSubCollectionEntity

public PersistenceResponse updateSubCollectionEntity(EntityForm entityForm,
                                            ClassMetadata mainMetadata,
                                            Property field,
                                            Entity parentEntity,
                                            String collectionItemId,
                                            List<SectionCrumb> sectionCrumb)
                                              throws ServiceException,
                                                     ClassNotFoundException

Description copied from interface: AdminEntityService

Updates the specified collection item

Specified by:

updateSubCollectionEntity in interface AdminEntityService

Returns:

the persisted Entity

Throws:

ServiceException

ClassNotFoundException

updateSubCollectionEntity

public PersistenceResponse updateSubCollectionEntity(EntityForm entityForm,
                                            ClassMetadata mainMetadata,
                                            Property field,
                                            Entity parentEntity,
                                            String collectionItemId,
                                            String alternateId,
                                            List<SectionCrumb> sectionCrumbs)
                                              throws ServiceException,
                                                     ClassNotFoundException

Description copied from interface: AdminEntityService

Updates the specified collection item

Specified by:

updateSubCollectionEntity in interface AdminEntityService

Returns:

the persisted Entity

Throws:

ServiceException

ClassNotFoundException

removeSubCollectionEntity

public PersistenceResponse removeSubCollectionEntity(ClassMetadata mainMetadata,
                                            Property field,
                                            Entity parentEntity,
                                            String itemId,
                                            String priorKey,
                                            List<SectionCrumb> sectionCrumbs)
                                              throws ServiceException

Description copied from interface: AdminEntityService

Removes the given item from the specified collection.

Specified by:

removeSubCollectionEntity in interface AdminEntityService

priorKey - - only needed for Map type collections

Throws:

ServiceException

removeSubCollectionEntity

public PersistenceResponse removeSubCollectionEntity(ClassMetadata mainMetadata,
                                            Property field,
                                            Entity parentEntity,
                                            String itemId,
                                            String alternateId,
                                            String priorKey,
                                            List<SectionCrumb> sectionCrumbs)
                                              throws ServiceException

Description copied from interface: AdminEntityService

Removes the given item from the specified collection.

Specified by:

removeSubCollectionEntity in interface AdminEntityService

priorKey - - only needed for Map type collections

Throws:

ServiceException

getContextSpecificRelationshipId

public String getContextSpecificRelationshipId(ClassMetadata cmd,
                                      Entity entity,
                                      String propertyName)

Description copied from interface: AdminEntityService

Returns the appropriate id to use for the given entity/metadata and prefix when dealing with collections. For example, on the Product screen, we display associated media. However, this media is actually owned by the Sku entity, which means its property name is "defaultSku.skuMedia". In this case, when wanting to look up media for this product, we cannot use the id of the product. Instead, we need to use the id of the sku.

Specified by:

getContextSpecificRelationshipId in interface AdminEntityService

Returns:

the id to be used for this relationship

getIdProperty

public String getIdProperty(ClassMetadata cmd)
                     throws ServiceException

Description copied from interface: AdminEntityService

Returns the name of the property in this ClassMetadata that has field type set to SupportedFieldType.ID

Specified by:

getIdProperty in interface AdminEntityService

Returns:

the id property name

Throws:

ServiceException

add

public PersistenceResponse add(PersistencePackageRequest request)
                        throws ServiceException

Description copied from interface: AdminEntityService

Thin layer on top of DynamicEntityService.add(org.broadleafcommerce.openadmin.dto.PersistencePackage) that swallows all ValidationExceptions that could be thrown and still just returns a PersistenceResponse with the Entity that failed validation.

Specified by:

add in interface AdminEntityService

Returns:

Throws:

ServiceException - if there were exceptions other than a ValidationException that was thrown as a result of the attempted add

add

public PersistenceResponse add(PersistencePackageRequest request,
                      boolean transactional)
                        throws ServiceException

Description copied from interface: AdminEntityService

Works the same as AdminEntityService.add(PersistencePackageRequest) but you can optionally invoke the transactional version of DynamicEntityRemoteService.add(org.broadleafcommerce.openadmin.dto.PersistencePackage) in situations where you want to manage the transactions in a parent component

Specified by:

add in interface AdminEntityService

Returns:

Throws:

ServiceException

update

public PersistenceResponse update(PersistencePackageRequest request)
                           throws ServiceException

Description copied from interface: AdminEntityService

Thin layer on top of DynamicEntityService.update(org.broadleafcommerce.openadmin.dto.PersistencePackage)

Specified by:

update in interface AdminEntityService

Returns:

Throws:

ServiceException - if there were exceptions other than a ValidationException that was thrown as a result of the attempted update

update

public PersistenceResponse update(PersistencePackageRequest request,
                         boolean transactional)
                           throws ServiceException

Description copied from interface: AdminEntityService

Works the same as AdminEntityService.update(PersistencePackageRequest) but you can optionally invoke the transactional version of DynamicEntityRemoteService.update(org.broadleafcommerce.openadmin.dto.PersistencePackage) in situations where you want to manage the transactions in a parent component

Specified by:

update in interface AdminEntityService

Returns:

Throws:

ServiceException

inspect

public PersistenceResponse inspect(PersistencePackageRequest request)
                            throws ServiceException

Description copied from interface: AdminEntityService

Thin layer on top of DynamicEntityService.inspect(org.broadleafcommerce.openadmin.dto.PersistencePackage)

Specified by:

inspect in interface AdminEntityService

Returns:

Throws:

ServiceException

remove

public PersistenceResponse remove(PersistencePackageRequest request)
                           throws ServiceException

Description copied from interface: AdminEntityService

Thin layer on top of DynamicEntityService.remove(org.broadleafcommerce.openadmin.dto.PersistencePackage)

Specified by:

remove in interface AdminEntityService

Returns:

Throws:

ServiceException

remove

public PersistenceResponse remove(PersistencePackageRequest request,
                         boolean transactional)
                           throws ServiceException

Description copied from interface: AdminEntityService

Works the same as AdminEntityService.remove(PersistencePackageRequest) but you can optionally invoke the transactional version of DynamicEntityRemoteService.remove(org.broadleafcommerce.openadmin.dto.PersistencePackage) in situations where you want to manage the transactions in a parent component

Specified by:

remove in interface AdminEntityService

Returns:

Throws:

ServiceException

ensureEntityMarkedAsValidationFailure

protected void ensureEntityMarkedAsValidationFailure(ValidationException e,
                                         PersistencePackageRequest originalRequest)

Should be invoked when a ValidationException is thrown to verify that the Entity contained within the given originalRequest has a validationFailure = true

This will also check for a cause of ConstraintViolationException and add a gloal error to that.

fetch

public PersistenceResponse fetch(PersistencePackageRequest request)
                          throws ServiceException

Description copied from interface: AdminEntityService

Thin layer on top of DynamicEntityService.fetch(org.broadleafcommerce.openadmin.dto.PersistencePackage, org.broadleafcommerce.openadmin.dto.CriteriaTransferObject). This will glean and create a CriteriaTransferObject from PersistencePackageRequest.getFilterAndSortCriteria() to pass to DynamicEntityService.

Specified by:

fetch in interface AdminEntityService

Returns:

Throws:

ServiceException

getDefaultCto

protected CriteriaTransferObject getDefaultCto()

getForeignEntityName

public String getForeignEntityName(String owningClass,
                          String id)

Description copied from interface: AdminEntityService

For the given class (which could be an interface) and id, finds the AdminMainEntity value for the foreign entity

Specified by:

getForeignEntityName in interface AdminEntityService

Returns:

the friendly name for the given foreign entity

getDefaultMaxResults

protected int getDefaultMaxResults()