Interface SiteDao
- All Known Implementing Classes:
SiteDaoImpl
public interface SiteDao
-
Method Summary
Modifier and TypeMethodDescriptioncreate()
Creates an instance of Site based on the class matching the bean id of "org.broadleafcommerce.common.site.domain.Site"Creates a catalog usingEntityConfiguration
.Creates a new instance ofSiteCatalogXref
usingEntityConfiguration
.Finds a site by its id.Retrieves all catalogsretrieveCatalog
(Long id) Finds a catalog by its id.retrieveCatalogByName
(String name) Returns a default site.retrieveSiteByDomainOrDomainPrefix
(String domain, String prefix) Finds a site by its domain or domain prefix.retrieveSiteByIdentifier
(String identifier) Finds a site by itsSite.getSiteIdentifierValue()
.Persists the site changes.
-
Method Details
-
create
Site create()Creates an instance of Site based on the class matching the bean id of "org.broadleafcommerce.common.site.domain.Site"- Returns:
-
retrieve
Finds a site by its id.- Parameters:
id
-- Returns:
-
retrieveSiteByDomainOrDomainPrefix
Finds a site by its domain or domain prefix.- Parameters:
domain
-prefix
-- Returns:
-
retrieveSiteByIdentifier
Finds a site by itsSite.getSiteIdentifierValue()
.- Parameters:
identifier
-- Returns:
-
save
Persists the site changes.- Parameters:
site
-- Returns:
-
retrieveDefaultSite
Site retrieveDefaultSite()Returns a default site. This method returns null in the out of box implementation of Broadleaf. Extend for implementation specific behavior.- Returns:
-
readAllActiveSites
- Returns:
- a List of all sites in the system
-
retrieveCatalog
Finds a catalog by its id.- Parameters:
id
-- Returns:
- the catalog
-
retrieveCatalogByName
-
createCatalog
Catalog createCatalog()Creates a catalog usingEntityConfiguration
.- Returns:
- the catalog
-
createSiteCatalog
SiteCatalogXref createSiteCatalog()Creates a new instance ofSiteCatalogXref
usingEntityConfiguration
.- Returns:
- the site catalog
-
save
-
retrieveAllCatalogs
Retrieves all catalogs- Returns:
- the list of catalogs
-