com.broadleafcommerce.tenant.domain

Interface MultiTenantCatalog

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultiTenantCatalogImpl, WeaveCatalogImpl

public interface MultiTenantCatalog
extends Serializable

Interface that is added onto a Catalog via weaved in properties from MultiTenantCatalogImpl.

Author:

Phillip Verheyden (phillipuniverse), bpolster

Method Summary

Modifier and Type	Method and Description
ConfigurationStatusType	getConfigurationStatus() Describes whether or not the catalog has been marked as finished for configuration.
List<CatalogDerivedCatalogXref>	getDerivedCatalogs() Return the list of catalogs that derive from this one
List<CatalogDerivedCatalogXref>	getDerivedFromCatalogs() If this catalog is derived from one or more other catalogs, then this list will return those catalogs via the CatalogDerivedCatalogXref.
org.broadleafcommerce.common.site.domain.Site	getOwningSite() Returns the Site that owns this Catalog
Boolean	isHideFromCatalogSelection() Whether this Catalog should be hidden from catalog selection
void	setConfigurationStatus(ConfigurationStatusType configurationStatus)
void	setDerivedCatalogs(List<CatalogDerivedCatalogXref> derivedCatalogs) Set the list of catalogs that derive from this one
void	setDerivedFromCatalogs(List<CatalogDerivedCatalogXref> derivedFromCatalogs) Sets the list of catalogs (if any) from which this catalog was derived.
void	setHideFromCatalogSelection(Boolean hideFromCatalogSelection) Sets whether to hide this Catalog from catalog selection
void	setOwningSite(org.broadleafcommerce.common.site.domain.Site owningSite) Sets the Site that owns this catalog

Method Detail

getDerivedFromCatalogs

List<CatalogDerivedCatalogXref> getDerivedFromCatalogs()

If this catalog is derived from one or more other catalogs, then this list will return those catalogs via the CatalogDerivedCatalogXref.

Returns:

setDerivedFromCatalogs

void setDerivedFromCatalogs(List<CatalogDerivedCatalogXref> derivedFromCatalogs)

Sets the list of catalogs (if any) from which this catalog was derived.

Parameters:

derivedCatalogs -

getOwningSite

org.broadleafcommerce.common.site.domain.Site getOwningSite()

Returns the Site that owns this Catalog

Returns:

the owning site

setOwningSite

void setOwningSite(org.broadleafcommerce.common.site.domain.Site owningSite)

Sets the Site that owns this catalog

Parameters:

owningSite -

isHideFromCatalogSelection

Boolean isHideFromCatalogSelection()

Whether this Catalog should be hidden from catalog selection

Returns:

setHideFromCatalogSelection

void setHideFromCatalogSelection(Boolean hideFromCatalogSelection)

Sets whether to hide this Catalog from catalog selection

Parameters:

hideFromCatalogSelection -

getDerivedCatalogs

List<CatalogDerivedCatalogXref> getDerivedCatalogs()

Return the list of catalogs that derive from this one

Returns:

setDerivedCatalogs

void setDerivedCatalogs(List<CatalogDerivedCatalogXref> derivedCatalogs)

Set the list of catalogs that derive from this one

Parameters:

derivedCatalogs -

getConfigurationStatus

ConfigurationStatusType getConfigurationStatus()

Describes whether or not the catalog has been marked as finished for configuration. Only catalogs that have completed any applicable copying and are marked as finished by the user may be utilized by other catalogs or sites.

Returns:

setConfigurationStatus

void setConfigurationStatus(ConfigurationStatusType configurationStatus)