org.broadleafcommerce.common.entity.service

Class AbstractEntityInformationServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.common.entity.service.AbstractEntityInformationServiceExtensionHandler

All Implemented Interfaces:

EntityInformationServiceExtensionHandler, ExtensionHandler

public class AbstractEntityInformationServiceExtensionHandler
extends AbstractExtensionHandler
implements EntityInformationServiceExtensionHandler

Field Summary

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractEntityInformationServiceExtensionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionResultStatusType	getBaseProfileIdForSite(Site site, ExtensionResultHolder<Long> erh) Handler implementations will populate the ExtensionResultHolder with a valid base profile id if one exists for the site
ExtensionResultStatusType	getOkayToUseSiteDiscriminator(Object o, ExtensionResultHolder<Boolean> erh) Handler implementations will set the value of ExtensionResultHolder to true if the passed in object supports site discriminator usage.
ExtensionResultStatusType	updateEntityInformationDto(EntityInformationDto dto, Object entityInstance) Handler implementations will override or populate the values on the passed in dto.

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Constructor Detail

AbstractEntityInformationServiceExtensionHandler

public AbstractEntityInformationServiceExtensionHandler()

Method Detail

updateEntityInformationDto

public ExtensionResultStatusType updateEntityInformationDto(EntityInformationDto dto,
                                                   Object entityInstance)

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will override or populate the values on the passed in dto.

Specified by:

updateEntityInformationDto in interface EntityInformationServiceExtensionHandler

Parameters:

dto - EntityInformationDto the dto to add values to

entityInstance - the object to be examined

See Also:

EntityInformationServiceImpl#buildEntityInformationForObject(Object)}

getBaseProfileIdForSite

public ExtensionResultStatusType getBaseProfileIdForSite(Site site,
                                                ExtensionResultHolder<Long> erh)

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will populate the ExtensionResultHolder with a valid base profile id if one exists for the site

Specified by:

getBaseProfileIdForSite in interface EntityInformationServiceExtensionHandler

Parameters:

site - Site the Site to check for a base profile

erh - ExtensionResultHolder a container for the result

getOkayToUseSiteDiscriminator

public ExtensionResultStatusType getOkayToUseSiteDiscriminator(Object o,
                                                      ExtensionResultHolder<Boolean> erh)

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will set the value of ExtensionResultHolder to true if the passed in object supports site discriminator usage. For example, when running in a Multi-Tenant Broadleaf implementation.

Specified by:

getOkayToUseSiteDiscriminator in interface EntityInformationServiceExtensionHandler

Returns: