org.broadleafcommerce.common.entity.service

Interface EntityInformationServiceExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractEntityInformationServiceExtensionHandler, EntityInformationServiceExtensionManager

public interface EntityInformationServiceExtensionHandler
extends ExtensionHandler

ExtensionHandler for methods within EntityInformationService

Rather than implementing this interface directly you should extend your implementation from AbstractEntityInformationServiceExtensionHandler.

Intended to be used by enterprise and multi-tenant modules to populate a dto so that other modules can have easy access to this information w/out a formal dependency on the multi-tenant or enterprise modules.

Author:

bpolster

See Also:

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	updateEntityInformationDto(EntityInformationDto dto, Object entityInstance) Handler implementations will override or populate the values on the passed in dto.

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

getPriority, isEnabled

Method Detail

updateEntityInformationDto

ExtensionResultStatusType updateEntityInformationDto(EntityInformationDto dto,
                                                     Object entityInstance)

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

Parameters:

dto - EntityInformationDto the dto to add values to

entityInstance - the object to be examined

See Also:

EntityInformationServiceImpl#buildEntityInformationForObject(Object)}

getBaseProfileIdForSite

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

Parameters:

site - Site the Site to check for a base profile

erh - ExtensionResultHolder a container for the result

getChildSiteIdsForProfile

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

Parameters:

profile - Site the profile to check for the child sites

erh - a container for the result

getParentSiteForProfile

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

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

Parameters:

profile - Site the profile to check for the parent site

erh - ExtensionResultHolder a container for the result

getOkayToUseSiteDiscriminator

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. For example, when running in a Multi-Tenant Broadleaf implementation.

Parameters:

o -

Returns:

findAllCatalogs

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.

Parameters:

erh -

Returns:

getDefaultCatalogIdForSite

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

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

Parameters:

site - Site the Site to get the catalog id from

erh - ExtensionResultHolder a container for the result