org.broadleafcommerce.common.entity.service

Interface EntityInformationService

All Known Implementing Classes:

EntityInformationServiceImpl

public interface EntityInformationService

Class that provides guidance to modules that need to react when running in a multi-tenant mode. Especially, when an entity is associated with a Profile or Catalog.

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
EntityInformationDto	buildEntityInformationForObject(Object o) Given an object, populates EntityInformationDto with the associated site, profile, and catalog ids.
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.

Method Detail

buildEntityInformationForObject

EntityInformationDto buildEntityInformationForObject(Object o)

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.

Parameters:

o -

Returns:

getBaseProfileIdForSite

Long getBaseProfileIdForSite(Site site)

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

Parameters:

site -

Returns:

getChildSiteIdsForProfile

Set<Long> getChildSiteIdsForProfile(Site profile)

getParentSiteForProfile

Site getParentSiteForProfile(Site profile)

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

Parameters:

profile -

Returns:

getOkayToUseSiteDiscriminator

boolean getOkayToUseSiteDiscriminator(Object o)

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

Parameters:

o -

Returns:

findAllCatalogs

List<Catalog> findAllCatalogs()

Returns all of the catalogs, using multi-tenant mode

Returns:

getDefaultCatalogIdForSite

Long getDefaultCatalogIdForSite(Site site)

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

Parameters:

site -

Returns:

the default Catalog id