com.broadleafcommerce.tenant.domain

Class MultiTenantSiteImpl

java.lang.Object

com.broadleafcommerce.tenant.domain.MultiTenantSiteImpl

All Implemented Interfaces:

MultiTenantSite, Serializable

@Embeddable
public class MultiTenantSiteImpl
extends Object
implements MultiTenantSite

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.broadleafcommerce.openadmin.server.security.domain.AdminUser>	adminUsers
protected List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	assignedCatalogs
protected List<SiteProfileXref>	assignedProfiles
protected org.broadleafcommerce.common.site.domain.Site	baseProfile
protected List<org.broadleafcommerce.common.site.domain.Site>	childProfiles
protected String	configurationStatus
protected org.broadleafcommerce.common.site.domain.Catalog	defaultCatalog
protected String	deploymentStatus
protected Boolean	hideFromProfileSelection
protected List<org.broadleafcommerce.common.site.domain.Catalog>	managedCatalogs
protected org.broadleafcommerce.common.site.domain.Site	parent
protected Long	parentSiteId
protected String	siteType

Constructor Summary

Constructors

Constructor and Description
MultiTenantSiteImpl()

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.
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.
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.
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> managedCatalogs) Sets list of catalogs owned by this site.
void	setParent(org.broadleafcommerce.common.site.domain.Site parent)
void	setParentSiteId(Long parentSiteId) Sets the id Site of SiteType.TEMPLATE that created this site
void	setSiteType(SiteType siteType) Sets the SiteType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parent

protected org.broadleafcommerce.common.site.domain.Site parent

siteType

protected String siteType

assignedCatalogs

protected List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> assignedCatalogs

assignedProfiles

protected List<SiteProfileXref> assignedProfiles

managedCatalogs

protected List<org.broadleafcommerce.common.site.domain.Catalog> managedCatalogs

childProfiles

protected List<org.broadleafcommerce.common.site.domain.Site> childProfiles

adminUsers

protected List<org.broadleafcommerce.openadmin.server.security.domain.AdminUser> adminUsers

defaultCatalog

protected org.broadleafcommerce.common.site.domain.Catalog defaultCatalog

baseProfile

protected org.broadleafcommerce.common.site.domain.Site baseProfile

parentSiteId

protected Long parentSiteId

deploymentStatus

protected String deploymentStatus

hideFromProfileSelection

protected Boolean hideFromProfileSelection

configurationStatus

protected String configurationStatus

Constructor Detail

MultiTenantSiteImpl

public MultiTenantSiteImpl()

Method Detail

getSiteType

public SiteType getSiteType()

Description copied from interface: MultiTenantSite

Returns the SiteType

Specified by:

getSiteType in interface MultiTenantSite

Returns:

the SiteType

setSiteType

public void setSiteType(SiteType siteType)

Description copied from interface: MultiTenantSite

Sets the SiteType

Specified by:

setSiteType in interface MultiTenantSite

getAssignedCatalogs

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

Deprecated.

Description copied from interface: MultiTenantSite

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

Specified by:

getAssignedCatalogs in interface MultiTenantSite

Returns:

setAssignedCatalogs

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

Deprecated.

Description copied from interface: MultiTenantSite

Sets the catalog assigned to this site.

Specified by:

setAssignedCatalogs in interface MultiTenantSite

getAssignedProfiles

public List<SiteProfileXref> getAssignedProfiles()

Description copied from interface: MultiTenantSite

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

Specified by:

getAssignedProfiles in interface MultiTenantSite

Returns:

setAssignedProfiles

public void setAssignedProfiles(List<SiteProfileXref> assignedProfiles)

Description copied from interface: MultiTenantSite

Sets the catalog assigned to this site.

Specified by:

setAssignedProfiles in interface MultiTenantSite

getManagedCatalogs

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

Description copied from interface: MultiTenantSite

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

Specified by:

getManagedCatalogs in interface MultiTenantSite

Returns:

setManagedCatalogs

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

Description copied from interface: MultiTenantSite

Sets list of catalogs owned by this site.

Specified by:

setManagedCatalogs in interface MultiTenantSite

getChildProfiles

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

Description copied from interface: MultiTenantSite

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

Specified by:

getChildProfiles in interface MultiTenantSite

Returns:

setChildProfiles

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

Description copied from interface: MultiTenantSite

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

Specified by:

setChildProfiles in interface MultiTenantSite

getDefaultCatalog

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

Description copied from interface: MultiTenantSite

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

Specified by:

getDefaultCatalog in interface MultiTenantSite

Returns:

the Catalog

setDefaultCatalog

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

Description copied from interface: MultiTenantSite

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

Specified by:

setDefaultCatalog in interface MultiTenantSite

getBaseProfile

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

Description copied from interface: MultiTenantSite

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

Specified by:

getBaseProfile in interface MultiTenantSite

Returns:

the base profile Site

setBaseProfile

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

Description copied from interface: MultiTenantSite

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

Specified by:

setBaseProfile in interface MultiTenantSite

getParentSiteId

public Long getParentSiteId()

Description copied from interface: MultiTenantSite

Returns the id of the Site that created this site.

Specified by:

getParentSiteId in interface MultiTenantSite

Returns:

setParentSiteId

public void setParentSiteId(Long parentSiteId)

Description copied from interface: MultiTenantSite

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

Specified by:

setParentSiteId in interface MultiTenantSite

getParent

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

Description copied from interface: MultiTenantSite

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

Specified by:

getParent in interface MultiTenantSite

Returns:

setParent

public void setParent(org.broadleafcommerce.common.site.domain.Site parent)

getAdminUsers

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

Description copied from interface: MultiTenantSite

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

Specified by:

getAdminUsers in interface MultiTenantSite

Returns:

setAdminUsers

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

Description copied from interface: MultiTenantSite

Sets the list of adminUsers for this site.

Specified by:

setAdminUsers in interface MultiTenantSite

getDeploymentStatus

public DeploymentStatus getDeploymentStatus()

Description copied from interface: MultiTenantSite

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

Specified by:

getDeploymentStatus in interface MultiTenantSite

Returns:

setDeploymentStatus

public void setDeploymentStatus(DeploymentStatus deploymentStatus)

Description copied from interface: MultiTenantSite

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

Specified by:

setDeploymentStatus in interface MultiTenantSite

isHideFromProfileSelection

public Boolean isHideFromProfileSelection()

Description copied from interface: MultiTenantSite

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

Specified by:

isHideFromProfileSelection in interface MultiTenantSite

Returns:

setHideFromProfileSelection

public void setHideFromProfileSelection(Boolean hideFromProfileSelection)

Description copied from interface: MultiTenantSite

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

Specified by:

setHideFromProfileSelection in interface MultiTenantSite

getTemplateSiteVisibleCatalogs

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

Specified by:

getTemplateSiteVisibleCatalogs in interface MultiTenantSite

buildTemplateSiteVisibleCatalogs

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

Specified by:

buildTemplateSiteVisibleCatalogs in interface MultiTenantSite

getStandardSiteVisibleCatalogs

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

Deprecated.

Description copied from interface: MultiTenantSite

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

Specified by:

getStandardSiteVisibleCatalogs in interface MultiTenantSite

Returns:

the set of catalogs

getConfigurationStatus

public ConfigurationStatusType getConfigurationStatus()

Description copied from interface: MultiTenantSite

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.

Specified by:

getConfigurationStatus in interface MultiTenantSite

Returns:

setConfigurationStatus

public void setConfigurationStatus(ConfigurationStatusType configurationStatus)

Specified by:

setConfigurationStatus in interface MultiTenantSite