Package org.broadleafcommerce.common.entity.service

Class EntityInformationServiceImpl

java.lang.Object

org.broadleafcommerce.common.entity.service.EntityInformationServiceImpl

All Implemented Interfaces:

EntityInformationService

@Service("blEntityInformationService")
public class EntityInformationServiceImpl
extends Object
implements EntityInformationService

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field	Description
protected EntityInformationServiceExtensionManager	extensionManager

Constructor Summary

Constructors

Constructor	Description
EntityInformationServiceImpl()

Method Summary

Modifier and Type	Method	Description
EntityInformationDto	buildBasicEntityInformationForObject(Object o)
EntityInformationDto	buildEntityInformationForObject(Object o)	Given an object, populates EntityInformationDto with the associated site, profile, and catalog ids.
protected EntityInformationDto	createEntityInformationDto(Object o)	Factory method for instantiating the EntityInformationDto
List<Catalog>	findAllCatalogs()	Returns all of the catalogs, using multi-tenant mode
Long	getBaseProfileIdForSite(Site site)	Given a Site object, returns the Base Profile Id if one exists.
Set<Long>	getChildSiteIdsForProfile(Site profile)
Long	getDefaultCatalogIdForSite(Site site)	Given a Site object, returns the default catalog id.
boolean	getOkayToUseSiteDiscriminator(Object o)	Given an entity instance, returns true if the object has access to a Site Discriminator.
Site	getParentSiteForProfile(Site profile)	Given a profile Site object, returns the parent site, if one exists.
String	getTypeForSite(Site site)

Methods inherited from class java.lang.Object

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

Field Details

extensionManager

protected EntityInformationServiceExtensionManager extensionManager

Constructor Details

EntityInformationServiceImpl

public EntityInformationServiceImpl()

Method Details

buildEntityInformationForObject

public EntityInformationDto buildEntityInformationForObject(Object o)

Description copied from interface: EntityInformationService

Given an object, populates EntityInformationDto with the associated site, profile, and catalog ids.

This method does nothing by default and instead relies on the EntityInformationServiceExtensionManager to populate the correct values. Designed for use with the commercial "workflow" and "multi-tenant" modules.

Specified by:

buildEntityInformationForObject in interface EntityInformationService

Returns:

buildBasicEntityInformationForObject

public EntityInformationDto buildBasicEntityInformationForObject(Object o)

Specified by:

buildBasicEntityInformationForObject in interface EntityInformationService

getBaseProfileIdForSite

public Long getBaseProfileIdForSite(Site site)

Description copied from interface: EntityInformationService

Given a Site object, returns the Base Profile Id if one exists. This method provides a hook for Broadleaf MultiTenant functionality

Specified by:

getBaseProfileIdForSite in interface EntityInformationService

Returns:

getTypeForSite

public String getTypeForSite(Site site)

Specified by:

getTypeForSite in interface EntityInformationService

getChildSiteIdsForProfile

public Set<Long> getChildSiteIdsForProfile(Site profile)

Specified by:

getChildSiteIdsForProfile in interface EntityInformationService

getParentSiteForProfile

public Site getParentSiteForProfile(Site profile)

Description copied from interface: EntityInformationService

Given a profile Site object, returns the parent site, if one exists. This method provides a hook for Broadleaf MultiTenant functionality.

Specified by:

getParentSiteForProfile in interface EntityInformationService

Returns:

getOkayToUseSiteDiscriminator

public boolean getOkayToUseSiteDiscriminator(Object o)

Description copied from interface: EntityInformationService

Given an entity instance, returns true if the object has access to a Site Discriminator.

Specified by:

getOkayToUseSiteDiscriminator in interface EntityInformationService

Returns:

getDefaultCatalogIdForSite

public Long getDefaultCatalogIdForSite(Site site)

Description copied from interface: EntityInformationService

Given a Site object, returns the default catalog id. This method provides a hook for Broadleaf MultiTenant functionality

Specified by:

getDefaultCatalogIdForSite in interface EntityInformationService

Returns:

the default Catalog id

findAllCatalogs

public List<Catalog> findAllCatalogs()

Description copied from interface: EntityInformationService

Returns all of the catalogs, using multi-tenant mode

Specified by:

findAllCatalogs in interface EntityInformationService

Returns:

createEntityInformationDto

protected EntityInformationDto createEntityInformationDto(Object o)

Factory method for instantiating the EntityInformationDto

Returns: