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

Modifier and Type	Method and Description
ExtensionResultStatusType	findAllCatalogs(ExtensionResultHolder<List<Catalog>> erh) Handler implementations will set the value of ExtensionResultHolder to a list of all catalogs, specifically when running in a Multi-Tenant Broadleaf implementation.
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	getChildSiteIdsForProfile(Site profile, ExtensionResultHolder<Set<Long>> erh) Handler implementations will populate the ExtensionResultHolder with a valid child site ids whose base profile is the given profile
ExtensionResultStatusType	getDefaultCatalogIdForSite(Site site, ExtensionResultHolder<Long> erh) Handler implementations will populate the ExtensionResultHolder with a valid default catalog id 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	getParentSiteForProfile(Site profile, ExtensionResultHolder<Site> erh) Handler implementations will popoulate the ExtensionResultHolder with a valid parent site if one exists for the profile
ExtensionResultStatusType	getTypeForSite(Site site, ExtensionResultHolder<String> erh)
ExtensionResultStatusType	updateBasicEntityInformationDto(EntityInformationDto dto, Object entityInstance)
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)}

updateBasicEntityInformationDto

public ExtensionResultStatusType updateBasicEntityInformationDto(EntityInformationDto dto,
                                                                 Object entityInstance)

Specified by:

updateBasicEntityInformationDto in interface EntityInformationServiceExtensionHandler

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

getTypeForSite

public ExtensionResultStatusType getTypeForSite(Site site,
                                                ExtensionResultHolder<String> erh)

Specified by:

getTypeForSite in interface EntityInformationServiceExtensionHandler

getChildSiteIdsForProfile

public ExtensionResultStatusType getChildSiteIdsForProfile(Site profile,
                                                           ExtensionResultHolder<Set<Long>> erh)

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will populate the ExtensionResultHolder with a valid child site ids whose base profile is the given profile

Specified by:

getChildSiteIdsForProfile in interface EntityInformationServiceExtensionHandler

Parameters:

profile - Site the profile to check for the child sites

erh - a container for the result

getParentSiteForProfile

public ExtensionResultStatusType getParentSiteForProfile(Site profile,
                                                         ExtensionResultHolder<Site> erh)

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will popoulate the ExtensionResultHolder with a valid parent site if one exists for the profile

Specified by:

getParentSiteForProfile in interface EntityInformationServiceExtensionHandler

Parameters:

profile - Site the profile to check for the parent site

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:

getDefaultCatalogIdForSite

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

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will populate the ExtensionResultHolder with a valid default catalog id for the site

Specified by:

getDefaultCatalogIdForSite in interface EntityInformationServiceExtensionHandler

Parameters:

site - Site the Site to get the catalog id from

erh - ExtensionResultHolder a container for the result

findAllCatalogs

public ExtensionResultStatusType findAllCatalogs(ExtensionResultHolder<List<Catalog>> erh)

Description copied from interface: EntityInformationServiceExtensionHandler

Handler implementations will set the value of ExtensionResultHolder to a list of all catalogs, specifically when running in a Multi-Tenant Broadleaf implementation.

Specified by:

findAllCatalogs in interface EntityInformationServiceExtensionHandler

Returns: