org.broadleafcommerce.common.site.dao

Interface SiteDao

All Known Implementing Classes:

SiteDaoImpl

public interface SiteDao

Method Summary

Modifier and Type	Method and Description
Site	create() Creates an instance of Site based on the class matching the bean id of "org.broadleafcommerce.common.site.domain.Site"
Catalog	createCatalog() Creates a catalog using EntityConfiguration.
SiteCatalogXref	createSiteCatalog() Creates a new instance of SiteCatalogXref using EntityConfiguration.
List<Site>	readAllActiveSites()
Site	retrieve(Long id) Finds a site by its id.
List<Catalog>	retrieveAllCatalogs() Retrieves all catalogs
Catalog	retrieveCatalog(Long id) Finds a catalog by its id.
Catalog	retrieveCatalogByName(String name)
Site	retrieveDefaultSite() Returns a default site.
Site	retrieveSiteByDomainOrDomainPrefix(String domain, String prefix) Finds a site by its domain or domain prefix.
Site	retrieveSiteByIdentifier(String identifier) Finds a site by its Site.getSiteIdentifierValue().
Catalog	save(Catalog catalog)
Site	save(Site site) Persists the site changes.

Method Detail

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

Site retrieve(Long id)

Finds a site by its id.

Parameters:

id -

Returns:

retrieveSiteByDomainOrDomainPrefix

Site retrieveSiteByDomainOrDomainPrefix(String domain,
                                        String prefix)

Finds a site by its domain or domain prefix.

Parameters:

domain -

prefix -

Returns:

retrieveSiteByIdentifier

Site retrieveSiteByIdentifier(String identifier)

Finds a site by its Site.getSiteIdentifierValue().

Parameters:

identifier -

Returns:

save

Site save(Site site)

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

List<Site> readAllActiveSites()

Returns:

a List of all sites in the system

retrieveCatalog

Catalog retrieveCatalog(Long id)

Finds a catalog by its id.

Parameters:

id -

Returns:

the catalog

retrieveCatalogByName

Catalog retrieveCatalogByName(String name)

createCatalog

Catalog createCatalog()

Creates a catalog using EntityConfiguration.

Returns:

the catalog

createSiteCatalog

SiteCatalogXref createSiteCatalog()

Creates a new instance of SiteCatalogXref using EntityConfiguration.

Returns:

the site catalog

save

Catalog save(Catalog catalog)

retrieveAllCatalogs

List<Catalog> retrieveAllCatalogs()

Retrieves all catalogs

Returns:

the list of catalogs