com.broadleafcommerce.tenant.dao

Interface MultiTenantDao

All Known Implementing Classes:

MultiTenantDaoImpl

public interface MultiTenantDao

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
void	completeParameterizedAssociatedCatalogSubQuery(javax.persistence.Query query, org.broadleafcommerce.common.site.domain.Site currentSite) Set the currentSite parameter on the catalog sub query.
Long	countAllManagedSites(Long parentSiteId)
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllCatalogs()
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllCatalogs(boolean excludeArchived)
List<org.broadleafcommerce.common.site.domain.Site>	findAllManagedProfiles(Long profileId) Find all standard sites whose base profile matches the passed in id
List<org.broadleafcommerce.common.site.domain.Site>	findAllManagedSites(Long parentSiteId) Find any standard sites whose parent matches the passed in id
List<org.broadleafcommerce.common.site.domain.Site>	findAllManagedSites(Long parentSiteId, Integer limit, Integer offset) Paged version of findAllManagedSites(Long)
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllStandardSiteCatalogs()
List<MultiTenantSite>	findAllStandardSites() Finds all standard sites
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	findCatalogAssociationsById(Long siteId, Long catalogId) Find the association with the specific catalog id
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	findCatalogAssociationsByName(Long siteId, String catalogName) Find the association with the specific catalog name
org.broadleafcommerce.common.site.domain.Catalog	findCatalogById(Long id) Find Catalog by Id
List<CatalogDerivedCatalogXref>	findCatalogXrefsForCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog) Find CatalogDerivedCatalogXref for the passed in catalog.
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	findCatalogXrefsForSite(org.broadleafcommerce.common.site.domain.Site site) Find SiteCatalogXref for the passed in site.
List<Long>	findDefaultCatalogIdsByAssignedCatalogId(Long assignedCatalogId) Find the default catalogs for sites that are assigned the given catalog.
List<org.broadleafcommerce.common.site.domain.Site>	findDerivedSitesFromCatalogs(List<Long> parentCatalogs) Find Site instances whose catalogs have this catalog as a parent.
List<org.broadleafcommerce.common.site.domain.Site>	findDerivedSitesFromProfiles(List<Long> parentProfiles) Find Site instances whose profile have this profile as a parent.
List<MultiTenantSite>	findManagedProfileSites(Long parentSiteId) Find any profile sites whose parent matches the passed in id
org.broadleafcommerce.common.site.domain.Catalog	findOwnedCatalog(Long siteId, Long catalogId) If the candidate catalog is owned by the current site, return it.
List<Long>	findSiteCatalogIdsByAssignedCatalogId(Long assignedCatalogId) Find the catalogs that hold site overrides or synced copies for this assigned catalog's id.
org.broadleafcommerce.common.site.domain.SiteCatalogXref	findSiteCatalogXref(Long id) Find the xref, if exists, for the given site and catalog
List<MultiTenantSite>	findStandardSitesForAssignedCatalog(Long assignedCatalogId) Find any standard sites who have the designated catalog assigned
javax.persistence.criteria.Subquery<Long>	getAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria) Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of catalogs assigned to a site.
javax.persistence.criteria.Subquery<Long>	getAssociatedSiteSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria, boolean alwaysAllowAdminStatus) Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of owning sites for all catalogs assigned to a site.
javax.persistence.criteria.Subquery<Long>	getOwnedCatalogsSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria) Similar to getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery) except that this places a further restriction on only retrieving the associated catalogs that are also owned by the currentSite
javax.persistence.criteria.Subquery<Long>	getParameterizedAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria) Same as getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery), except that the subquery returns uses a parameter for the currentSite.
org.broadleafcommerce.common.site.domain.Catalog	getTargetCatalogBasedOnMutability(Long candidateCatalogId, Long siteId) Get the current catalog context based on a candidate catalog.
Boolean	isCatalogUsedByChildSites(Long parentSiteId, Long catalogId) Whether the catalog of the passed in id is assigned to children of the passed in parent site id
Boolean	isMultipleManagedCatalogs(Long siteId) Determine, in a performant way, whether or not the current site is managing more than one active catalog
Boolean	isMultipleManagedCatalogsEligibleForAdd(Long siteId) Determine, in a performant way, whether or not the current site is managing more than one active and eligible for add catalog.
CatalogDerivedCatalogXref	readDerivedCatalogXrefById(Long id) Finds a given CatalogDerivedCatalogXref entity by its id
List<org.broadleafcommerce.common.site.domain.Site>	retrieveChildrenSitesByParentSiteId(Long id) Retrieves a list of children sites for the site id passed in
CatalogDerivedCatalogXref	saveDerivedCatalogXref(CatalogDerivedCatalogXref xref) Persists the given CatalogDerivedCatalogXref entity to the database.

Method Detail

findDerivedSitesFromCatalogs

List<org.broadleafcommerce.common.site.domain.Site> findDerivedSitesFromCatalogs(List<Long> parentCatalogs)

Find Site instances whose catalogs have this catalog as a parent.

Parameters:

parentCatalogs - the catalog on which a derived site's catalog is based

Returns:

the list of derived catalog containing sites

findDerivedSitesFromProfiles

List<org.broadleafcommerce.common.site.domain.Site> findDerivedSitesFromProfiles(List<Long> parentProfiles)

Find Site instances whose profile have this profile as a parent.

Parameters:

parentProfiles - the profile on which a derived site's profile is based

Returns:

the list of derived profile containing sites

findStandardSitesForAssignedCatalog

List<MultiTenantSite> findStandardSitesForAssignedCatalog(Long assignedCatalogId)

Find any standard sites who have the designated catalog assigned

Parameters:

assignedCatalogId -

Returns:

findManagedProfileSites

List<MultiTenantSite> findManagedProfileSites(Long parentSiteId)

Find any profile sites whose parent matches the passed in id

Parameters:

parentSiteId -

Returns:

findAllManagedSites

List<org.broadleafcommerce.common.site.domain.Site> findAllManagedSites(Long parentSiteId)

Find any standard sites whose parent matches the passed in id

Parameters:

parentSiteId -

Returns:

See Also:

#findAllManagedSites(Long, Integer, Integer)}

findAllManagedSites

List<org.broadleafcommerce.common.site.domain.Site> findAllManagedSites(Long parentSiteId,
                                                                        Integer limit,
                                                                        Integer offset)

Paged version of findAllManagedSites(Long)

Parameters:

parentSiteId -

limit - how many results to limit

offset - where to start the result set

Returns:

See Also:

#findAllManagedSites(Long, Integer, Integer)}

countAllManagedSites

Long countAllManagedSites(Long parentSiteId)

findAllManagedProfiles

List<org.broadleafcommerce.common.site.domain.Site> findAllManagedProfiles(Long profileId)

Find all standard sites whose base profile matches the passed in id

Parameters:

profileId -

Returns:

isCatalogUsedByChildSites

Boolean isCatalogUsedByChildSites(Long parentSiteId,
                                  Long catalogId)

Whether the catalog of the passed in id is assigned to children of the passed in parent site id

Parameters:

parentSiteId -

catalogId -

Returns:

isMultipleManagedCatalogs

Boolean isMultipleManagedCatalogs(Long siteId)

Determine, in a performant way, whether or not the current site is managing more than one active catalog

Parameters:

siteId -

Returns:

isMultipleManagedCatalogsEligibleForAdd

Boolean isMultipleManagedCatalogsEligibleForAdd(Long siteId)

Determine, in a performant way, whether or not the current site is managing more than one active and eligible for add catalog.

Parameters:

siteId -

Returns:

findOwnedCatalog

org.broadleafcommerce.common.site.domain.Catalog findOwnedCatalog(Long siteId,
                                                                  Long catalogId)

If the candidate catalog is owned by the current site, return it. Otherwise, return null;

Parameters:

siteId -

catalogId -

Returns:

findCatalogById

org.broadleafcommerce.common.site.domain.Catalog findCatalogById(Long id)

Find Catalog by Id

Parameters:

id - of the catalog to find.

Returns:

the catalog

findCatalogXrefsForSite

List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> findCatalogXrefsForSite(org.broadleafcommerce.common.site.domain.Site site)

Find SiteCatalogXref for the passed in site.

Parameters:

site -

Returns:

the List of SiteCatalogXrefs

findSiteCatalogIdsByAssignedCatalogId

List<Long> findSiteCatalogIdsByAssignedCatalogId(Long assignedCatalogId)

Find the catalogs that hold site overrides or synced copies for this assigned catalog's id.

Parameters:

assignedCatalogId - usually the id of a TEMPLATE Site-level Catalog.

Returns:

a List of the site override catalogs

findDefaultCatalogIdsByAssignedCatalogId

List<Long> findDefaultCatalogIdsByAssignedCatalogId(Long assignedCatalogId)

Find the default catalogs for sites that are assigned the given catalog.

Parameters:

assignedCatalogId - usually the id of a TEMPLATE Site-level Catalog.

Returns:

a List of the default catalogs

findCatalogXrefsForCatalog

List<CatalogDerivedCatalogXref> findCatalogXrefsForCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog)

Find CatalogDerivedCatalogXref for the passed in catalog.

Parameters:

catalog -

Returns:

the List of CatalogDerivedCatalogXref

findAllStandardSiteCatalogs

List<org.broadleafcommerce.common.site.domain.Catalog> findAllStandardSiteCatalogs()

findAllCatalogs

List<org.broadleafcommerce.common.site.domain.Catalog> findAllCatalogs()

findAllCatalogs

List<org.broadleafcommerce.common.site.domain.Catalog> findAllCatalogs(boolean excludeArchived)

readDerivedCatalogXrefById

CatalogDerivedCatalogXref readDerivedCatalogXrefById(Long id)

Finds a given CatalogDerivedCatalogXref entity by its id

Parameters:

id -

Returns:

the CatalogDerivedCatalogXref

findSiteCatalogXref

org.broadleafcommerce.common.site.domain.SiteCatalogXref findSiteCatalogXref(Long id)

Find the xref, if exists, for the given site and catalog

Parameters:

id -

Returns:

saveDerivedCatalogXref

CatalogDerivedCatalogXref saveDerivedCatalogXref(CatalogDerivedCatalogXref xref)

Persists the given CatalogDerivedCatalogXref entity to the database.

Parameters:

xref -

Returns:

the persisted version of the CatalogDerivedCatalogXref

findAllStandardSites

List<MultiTenantSite> findAllStandardSites()

Finds all standard sites

Returns:

a List of Site's

retrieveChildrenSitesByParentSiteId

List<org.broadleafcommerce.common.site.domain.Site> retrieveChildrenSitesByParentSiteId(Long id)

Retrieves a list of children sites for the site id passed in

Parameters:

id -

Returns:

getAssociatedSiteSubQuery

javax.persistence.criteria.Subquery<Long> getAssociatedSiteSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                    javax.persistence.criteria.CriteriaBuilder builder,
                                                                    javax.persistence.criteria.CriteriaQuery criteria,
                                                                    boolean alwaysAllowAdminStatus)

Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of owning sites for all catalogs assigned to a site.

Parameters:

currentSite - the site whose assigned catalogs are reviewed

builder - the CriteriaBuilder from the containing criteria creation

criteria - the CriteriaQuery from the containing criteria creation

alwaysAllowAdminStatus - whether or not calls should allow both PENDING and ONLINE catalog associations, regardless of the request context state

Returns:

the subquery

getAssociatedCatalogSubQuery

javax.persistence.criteria.Subquery<Long> getAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                       javax.persistence.criteria.CriteriaBuilder builder,
                                                                       javax.persistence.criteria.CriteriaQuery criteria)

Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of catalogs assigned to a site.

Parameters:

currentSite - the site whose assigned catalogs are reviewed

builder - the CriteriaBuilder from the containing criteria creation

criteria - the CriteriaQuery from the containing criteria creation

Returns:

the subquery

getParameterizedAssociatedCatalogSubQuery

javax.persistence.criteria.Subquery<Long> getParameterizedAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                                    javax.persistence.criteria.CriteriaBuilder builder,
                                                                                    javax.persistence.criteria.CriteriaQuery criteria)

Same as getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery), except that the subquery returns uses a parameter for the currentSite. The final Query instance should be passed to completeParameterizedAssociatedCatalogSubQuery(Query, Site).

Parameters:

currentSite -

builder -

criteria -

Returns:

completeParameterizedAssociatedCatalogSubQuery

void completeParameterizedAssociatedCatalogSubQuery(javax.persistence.Query query,
                                                    org.broadleafcommerce.common.site.domain.Site currentSite)

Set the currentSite parameter on the catalog sub query.

Parameters:

query -

currentSite -

getOwnedCatalogsSubQuery

javax.persistence.criteria.Subquery<Long> getOwnedCatalogsSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                   javax.persistence.criteria.CriteriaBuilder builder,
                                                                   javax.persistence.criteria.CriteriaQuery criteria)

Similar to getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery) except that this places a further restriction on only retrieving the associated catalogs that are also owned by the currentSite

Parameters:

currentSite - the site whose assigned catalogs are reviewed

builder - the CriteriaBuilder from the containing criteria creation

criteria - the CriteriaQuery from the containing criteria creation

Returns:

the subquery

getTargetCatalogBasedOnMutability

org.broadleafcommerce.common.site.domain.Catalog getTargetCatalogBasedOnMutability(Long candidateCatalogId,
                                                                                   Long siteId)

Get the current catalog context based on a candidate catalog. If a synced catalog association is found, then use this catalog. If a sparse, customizable association is found whose implicit catalog matches the candidate, then use the real catalog (not the implicit catalog) from the association.

Parameters:

candidateCatalogId - the candidate catalog (presumably taken from a catalog discriminated entity)

siteId - the current site

Returns:

findCatalogAssociationsByName

List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> findCatalogAssociationsByName(Long siteId,
                                                                                             String catalogName)

Find the association with the specific catalog name

Parameters:

siteId -

catalogName -

Returns:

findCatalogAssociationsById

List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> findCatalogAssociationsById(Long siteId,
                                                                                           Long catalogId)

Find the association with the specific catalog id

Parameters:

siteId -

catalogId -

Returns: