org.broadleafcommerce.common.entity.service

Class EntityInformationServiceExtensionManager

java.lang.Object

org.broadleafcommerce.common.extension.ExtensionManager<EntityInformationServiceExtensionHandler>

org.broadleafcommerce.common.entity.service.EntityInformationServiceExtensionManager

All Implemented Interfaces:

InvocationHandler, EntityInformationServiceExtensionHandler, ExtensionHandler

@Service(value="blEntityInformationServiceExtensionManager")
public class EntityInformationServiceExtensionManager
extends ExtensionManager<EntityInformationServiceExtensionHandler>
implements EntityInformationServiceExtensionHandler

Extension manager that holds the list of EntityInformationServiceExtensionHandler.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionManagerOperation	findAllCatalogs
static ExtensionManagerOperation	getBaseProfileIdForSite
static ExtensionManagerOperation	getChildSiteIdsForProfile
static ExtensionManagerOperation	getDefaultCatalogIdForSite
static ExtensionManagerOperation	getOkayToUseSiteDiscriminator
static ExtensionManagerOperation	getParentSiteForProfile
static ExtensionManagerOperation	getTypeForSite
static ExtensionManagerOperation	updateBasicEntityInformationDto
static ExtensionManagerOperation	updateEntityInformationDto

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

extensionHandler, handlers, handlersSorted, LOCK_OBJECT

Constructor Summary

Constructors

Constructor and Description
EntityInformationServiceExtensionManager()

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)
boolean	isEnabled() If false, the ExtensionManager should skip this Handler.
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.ExtensionManager

continueOnHandled, execute, getHandlers, getPriority, getProxy, invoke, registerHandler, setHandlers, shouldContinue, sortHandlers

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

Field Detail

getDefaultCatalogIdForSite

public static final ExtensionManagerOperation getDefaultCatalogIdForSite

updateEntityInformationDto

public static final ExtensionManagerOperation updateEntityInformationDto

updateBasicEntityInformationDto

public static final ExtensionManagerOperation updateBasicEntityInformationDto

getBaseProfileIdForSite

public static final ExtensionManagerOperation getBaseProfileIdForSite

getTypeForSite

public static final ExtensionManagerOperation getTypeForSite

getParentSiteForProfile

public static final ExtensionManagerOperation getParentSiteForProfile

getOkayToUseSiteDiscriminator

public static final ExtensionManagerOperation getOkayToUseSiteDiscriminator

findAllCatalogs

public static final ExtensionManagerOperation findAllCatalogs

getChildSiteIdsForProfile

public static final ExtensionManagerOperation getChildSiteIdsForProfile

Constructor Detail

EntityInformationServiceExtensionManager

public EntityInformationServiceExtensionManager()

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

isEnabled

public boolean isEnabled()

Description copied from interface: ExtensionHandler

If false, the ExtensionManager should skip this Handler.

Specified by:

isEnabled in interface ExtensionHandler

Returns:

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

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:

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:

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

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

getTypeForSite

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

Specified by:

getTypeForSite in interface EntityInformationServiceExtensionHandler