org.broadleafcommerce.common.site.domain

Class SiteImpl

java.lang.Object

org.broadleafcommerce.common.site.domain.SiteImpl

All Implemented Interfaces:

Serializable, Status, Site

@Entity
public class SiteImpl
extends Object
implements Site, Status

Created by bpolster.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArchiveStatus	archiveStatus
protected List<Catalog>	catalogs
protected Boolean	deactivated
protected Long	id
protected String	name
protected SandBox	productionSandbox
protected String	siteIdentifierType
protected String	siteIdentifierValue

Constructor Summary

Constructors

Constructor and Description
SiteImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkCloneable(Site site)
Site	clone() Retrieve an deep copy of this site.
Character	getArchived()
List<Catalog>	getCatalogs() Retrieve a list of product, category and offer groupings that this site has access to
Long	getId() Unique/internal id for a site.
String	getName() The display name for a site.
SandBox	getProductionSandbox() If null, then this is a single-site installation.
String	getSiteIdentifierType()
String	getSiteIdentifierValue() Used along with Site.getSiteResolutionType() to determine the current Site for a given request.
SiteResolutionType	getSiteResolutionType() Intended to be used along with the #getSiteIdentifierValue() by an implementation of SiteResolver to determine if this is the current site.
boolean	isActive()
boolean	isDeactivated()
boolean	isTemplateSite() This method will return true when the given site was created based on a template.
void	setArchived(Character archived)
void	setCatalogs(List<Catalog> catalogs) Set the list of product, category and offer groupings that this site has access to
void	setDeactivated(boolean deactivated)
void	setId(Long id) Sets the internal id for a site.
void	setName(String name) Sets the displayName for a site.
void	setProductionSandbox(SandBox productionSandbox) Sets the production sandbox.
void	setSiteIdentifierType(String siteIdentifierType)
void	setSiteIdentifierValue(String siteIdentifierValue)
void	setSiteResolutionType(SiteResolutionType siteResolutionType) Sets the site resolution type.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

name

protected String name

siteIdentifierType

protected String siteIdentifierType

siteIdentifierValue

protected String siteIdentifierValue

productionSandbox

protected SandBox productionSandbox

catalogs

protected List<Catalog> catalogs

deactivated

protected Boolean deactivated

archiveStatus

protected ArchiveStatus archiveStatus

Constructor Detail

SiteImpl

public SiteImpl()

Method Detail

getId

public Long getId()

Description copied from interface: Site

Unique/internal id for a site.

Specified by:

getId in interface Site

Returns:

setId

public void setId(Long id)

Description copied from interface: Site

Sets the internal id for a site.

Specified by:

setId in interface Site

getName

public String getName()

Description copied from interface: Site

The display name for a site.

Specified by:

getName in interface Site

Returns:

setName

public void setName(String name)

Description copied from interface: Site

Sets the displayName for a site.

Specified by:

setName in interface Site

getSiteIdentifierType

public String getSiteIdentifierType()

Specified by:

getSiteIdentifierType in interface Site

Returns:

setSiteIdentifierType

public void setSiteIdentifierType(String siteIdentifierType)

Specified by:

setSiteIdentifierType in interface Site

See Also:

Site.getSiteIdentifierType()

getSiteIdentifierValue

public String getSiteIdentifierValue()

Description copied from interface: Site

Used along with Site.getSiteResolutionType() to determine the current Site for a given request.

Specified by:

getSiteIdentifierValue in interface Site

Returns:

setSiteIdentifierValue

public void setSiteIdentifierValue(String siteIdentifierValue)

Specified by:

setSiteIdentifierValue in interface Site

getProductionSandbox

public SandBox getProductionSandbox()

Description copied from interface: Site

If null, then this is a single-site installation. Otherwise, each site must define it's production sandbox so that data can be properly segmented.

Specified by:

getProductionSandbox in interface Site

Returns:

setProductionSandbox

public void setProductionSandbox(SandBox productionSandbox)

Description copied from interface: Site

Sets the production sandbox. Typically configured via the database.

Specified by:

setProductionSandbox in interface Site

See Also:

Site.getProductionSandbox();

getSiteResolutionType

public SiteResolutionType getSiteResolutionType()

Description copied from interface: Site

Intended to be used along with the #getSiteIdentifierValue() by an implementation of SiteResolver to determine if this is the current site.

Specified by:

getSiteResolutionType in interface Site

Returns:

setSiteResolutionType

public void setSiteResolutionType(SiteResolutionType siteResolutionType)

Description copied from interface: Site

Sets the site resolution type.

Specified by:

setSiteResolutionType in interface Site

See Also:

Site.getSiteResolutionType()

getCatalogs

public List<Catalog> getCatalogs()

Description copied from interface: Site

Retrieve a list of product, category and offer groupings that this site has access to

Specified by:

getCatalogs in interface Site

Returns:

a list of catalog groupings

setCatalogs

public void setCatalogs(List<Catalog> catalogs)

Description copied from interface: Site

Set the list of product, category and offer groupings that this site has access to

Specified by:

setCatalogs in interface Site

Parameters:

catalogs - a list of catalog groupings

getArchived

public Character getArchived()

Specified by:

getArchived in interface Status

setArchived

public void setArchived(Character archived)

Specified by:

setArchived in interface Status

isActive

public boolean isActive()

Specified by:

isActive in interface Status

isDeactivated

public boolean isDeactivated()

Specified by:

isDeactivated in interface Site

setDeactivated

public void setDeactivated(boolean deactivated)

Specified by:

setDeactivated in interface Site

isTemplateSite

public boolean isTemplateSite()

Description copied from interface: Site

This method will return true when the given site was created based on a template.

Specified by:

isTemplateSite in interface Site

Returns:

whether or not this site is a TemplateSite

checkCloneable

public void checkCloneable(Site site)
                    throws CloneNotSupportedException,
                           SecurityException,
                           NoSuchMethodException

Throws:

CloneNotSupportedException

SecurityException

NoSuchMethodException

clone

public Site clone()

Description copied from interface: Site

Retrieve an deep copy of this site. Not bound by entity manager scope.

Specified by:

clone in interface Site

Overrides:

clone in class Object

Returns:

a deep copy of this site