com.broadleafcommerce.tenant.domain

Interface MultiTenantSite

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultiTenantSiteImpl, WeaveSiteImpl

public interface MultiTenantSite
extends Serializable

Weaves in the idea of a Site owning a set of Catalogs

Actual properties weaved in are defined in MultiTenantSiteImpl

Author:

Phillip Verheyden (phillipuniverse), bpolster

Method Summary

Modifier and Type	Method and Description
void	buildTemplateSiteVisibleCatalogs(Set<org.broadleafcommerce.common.site.domain.Catalog> catalogs, Set<Long> visitedSites, Set<Long> visitedCatalogs)
List<org.broadleafcommerce.openadmin.server.security.domain.AdminUser>	getAdminUsers() The list of admin users that are able to operate on this site and its children.
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	getAssignedCatalogs() Deprecated. this can be expensive depending on the member size. Consider a query approach instead. Review MultiTenantSiteUtil helper methods that may be applicable.
List<SiteProfileXref>	getAssignedProfiles() Returns a list of SiteCatalogXref that have been assigned to this site by its parent.
org.broadleafcommerce.common.site.domain.Site	getBaseProfile() Returns the base profile which is an instance of Site which has a SiteType.PROFILE or null if not base profile has been set.
List<org.broadleafcommerce.common.site.domain.Site>	getChildProfiles() If this site is a profile, return the list of other profiles who reference this one as their base profile
ConfigurationStatusType	getConfigurationStatus() Describes whether or not the catalog has been marked as finished for configuration.
org.broadleafcommerce.common.site.domain.Catalog	getDefaultCatalog() Returns the Catalog that is the default catalog for this site.
DeploymentStatus	getDeploymentStatus() For profile type sites, describes the lifecycle status of copying the profile related entities
List<org.broadleafcommerce.common.site.domain.Catalog>	getManagedCatalogs() Returns a list of Catalogs that have been created by this site.
org.broadleafcommerce.common.site.domain.Site	getParent() Reference to the site which this embed is contained.
Long	getParentSiteId() Returns the id of the Site that created this site.
SiteType	getSiteType() Returns the SiteType
Set<org.broadleafcommerce.common.site.domain.Catalog>	getStandardSiteVisibleCatalogs() Deprecated. This implementation performs poorly for large quantity catalog assignments. Callers should be refactored to ascertain catalog assignment information differently, likely through a more direct query oriented solution.
Set<org.broadleafcommerce.common.site.domain.Catalog>	getTemplateSiteVisibleCatalogs()
Boolean	isHideFromProfileSelection() Whether or not this profile should be hidden from profile selection.
void	setAdminUsers(List<org.broadleafcommerce.openadmin.server.security.domain.AdminUser> adminUsers) Sets the list of adminUsers for this site.
void	setAssignedCatalogs(List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> assignedCatalogs) Deprecated. this can be expensive depending on the member size. Consider a query approach instead. Review MultiTenantSiteUtil helper methods that may be applicable.
void	setAssignedProfiles(List<SiteProfileXref> assignedProfiles) Sets the catalog assigned to this site.
void	setBaseProfile(org.broadleafcommerce.common.site.domain.Site baseProfile) Sets the base profile which is an instance of Site which has a SiteType.PROFILE.
void	setChildProfiles(List<org.broadleafcommerce.common.site.domain.Site> childProfiles) If this site is a profile, set the list of other profiles who reference this one as their base profile
void	setConfigurationStatus(ConfigurationStatusType configurationStatus)
void	setDefaultCatalog(org.broadleafcommerce.common.site.domain.Catalog defaultCatalog) Sets the default Catalog for this site.
void	setDeploymentStatus(DeploymentStatus deploymentStatus) For profile type sites, describes the lifecycle status of copying the profile related entities
void	setHideFromProfileSelection(Boolean hideFromProfileSelection) Set whether or not this profile should be hidden from profile selection.
void	setManagedCatalogs(List<org.broadleafcommerce.common.site.domain.Catalog> ownedCatalogs) Sets list of catalogs owned by this site.
void	setParentSiteId(Long parentSiteId) Sets the id Site of SiteType.TEMPLATE that created this site
void	setSiteType(SiteType siteType) Sets the SiteType

Method Detail

getSiteType

SiteType getSiteType()

Returns the SiteType

Returns:

the SiteType

setSiteType

void setSiteType(SiteType siteType)

Sets the SiteType

Parameters:

siteType -

getAssignedCatalogs

@Deprecated
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> getAssignedCatalogs()

Deprecated. this can be expensive depending on the member size. Consider a query approach instead. Review MultiTenantSiteUtil helper methods that may be applicable.

Returns a list of SiteCatalogXref that have been assigned to this site by its parent.

Returns:

setAssignedCatalogs

@Deprecated
void setAssignedCatalogs(List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> assignedCatalogs)

Deprecated. this can be expensive depending on the member size. Consider a query approach instead. Review MultiTenantSiteUtil helper methods that may be applicable.

Sets the catalog assigned to this site.

Parameters:

assignedCatalogs -

getAssignedProfiles

List<SiteProfileXref> getAssignedProfiles()

Returns a list of SiteCatalogXref that have been assigned to this site by its parent.

Returns:

setAssignedProfiles

void setAssignedProfiles(List<SiteProfileXref> assignedProfiles)

Sets the catalog assigned to this site.

Parameters:

assignedCatalogs -

getManagedCatalogs

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

Returns a list of Catalogs that have been created by this site.

Returns:

setManagedCatalogs

void setManagedCatalogs(List<org.broadleafcommerce.common.site.domain.Catalog> ownedCatalogs)

Sets list of catalogs owned by this site.

Parameters:

assignedCatalogs -

getChildProfiles

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

If this site is a profile, return the list of other profiles who reference this one as their base profile

Returns:

setChildProfiles

void setChildProfiles(List<org.broadleafcommerce.common.site.domain.Site> childProfiles)

If this site is a profile, set the list of other profiles who reference this one as their base profile

Parameters:

childProfiles -

getDefaultCatalog

org.broadleafcommerce.common.site.domain.Catalog getDefaultCatalog()

Returns the Catalog that is the default catalog for this site. Default catalogs are only used with Sites of type SiteType.STANDARD.

Returns:

the Catalog

setDefaultCatalog

void setDefaultCatalog(org.broadleafcommerce.common.site.domain.Catalog defaultCatalog)

Sets the default Catalog for this site. Default catalogs are only used with Sites of type SiteType.STANDARD.

Parameters:

defaultCatalog -

getBaseProfile

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

Returns the base profile which is an instance of Site which has a SiteType.PROFILE or null if not base profile has been set. Base profiles are used with Sites of type SiteType.STANDARD or SiteType.PROFILE

Returns:

the base profile Site

setBaseProfile

void setBaseProfile(org.broadleafcommerce.common.site.domain.Site baseProfile)

Sets the base profile which is an instance of Site which has a SiteType.PROFILE. Used to allow content changes to flow through a hierarchy. Base profiles are used with Sites of type SiteType.STANDARD or SiteType.PROFILE

Parameters:

baseProfile -

getParentSiteId

Long getParentSiteId()

Returns the id of the Site that created this site.

Returns:

setParentSiteId

void setParentSiteId(Long parentSiteId)

Sets the id Site of SiteType.TEMPLATE that created this site

Parameters:

parentSiteId -

getAdminUsers

List<org.broadleafcommerce.openadmin.server.security.domain.AdminUser> getAdminUsers()

The list of admin users that are able to operate on this site and its children.

Returns:

setAdminUsers

void setAdminUsers(List<org.broadleafcommerce.openadmin.server.security.domain.AdminUser> adminUsers)

Sets the list of adminUsers for this site.

Parameters:

adminUsers -

getStandardSiteVisibleCatalogs

@Deprecated
Set<org.broadleafcommerce.common.site.domain.Catalog> getStandardSiteVisibleCatalogs()

Deprecated. This implementation performs poorly for large quantity catalog assignments. Callers should be refactored to ascertain catalog assignment information differently, likely through a more direct query oriented solution.

Returns a list of all catalogs this site has visibility into.

Returns:

the set of catalogs

Throws:

IllegalArgumentException - when this site is not of SiteType.STANDARD

isHideFromProfileSelection

Boolean isHideFromProfileSelection()

Whether or not this profile should be hidden from profile selection.

Returns:

setHideFromProfileSelection

void setHideFromProfileSelection(Boolean hideFromProfileSelection)

Set whether or not this profile should be hidden from profile selection.

Parameters:

hideFromProfileSelection -

getTemplateSiteVisibleCatalogs

Set<org.broadleafcommerce.common.site.domain.Catalog> getTemplateSiteVisibleCatalogs()

buildTemplateSiteVisibleCatalogs

void buildTemplateSiteVisibleCatalogs(Set<org.broadleafcommerce.common.site.domain.Catalog> catalogs,
                                      Set<Long> visitedSites,
                                      Set<Long> visitedCatalogs)

getParent

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

Reference to the site which this embed is contained. Note, this is not the "owning" or "parent site".

Returns:

getDeploymentStatus

DeploymentStatus getDeploymentStatus()

For profile type sites, describes the lifecycle status of copying the profile related entities

Returns:

setDeploymentStatus

void setDeploymentStatus(DeploymentStatus deploymentStatus)

For profile type sites, describes the lifecycle status of copying the profile related entities

Parameters:

deploymentStatus -

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)