org.broadleafcommerce.common.site.domain
Interface Site

All Superinterfaces:

Serializable

All Known Implementing Classes:

SiteImpl

public interface Site
extends Serializable

Created by bpolster.

Method Summary

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() Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site.
String	getSiteIdentifierValue() Used along with #getSiteIdentiferType() to determine the current Site for a given request.
void	setId(Long id) Sets the internal id for a site.
void	setName(String name) Sets the displayName for a site.
void	setProductionSandbox(SandBox sandbox) Sets the production sandbox.
void	setSiteIdentifierType(String siteIdentifierType) Sets the site identifier type.
void	setSiteIdentifierValue(String siteIdentifierValue)

Method Detail

getId

Long getId()

Unique/internal id for a site.

Returns:

setId

void setId(Long id)

Sets the internal id for a site.

Parameters:

id -

getName

String getName()

The display name for a site.

Returns:

setName

void setName(String name)

Sets the displayName for a site.

Parameters:

name -

getSiteIdentifierType

String getSiteIdentifierType()

Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site. Example type usage could be HOSTNAME, IP-ADDRESS, URL-PARAMETER. Custom SiteResolvers can be written to determine the current Site.

Returns:

setSiteIdentifierType

void setSiteIdentifierType(String siteIdentifierType)

Sets the site identifier type.

Parameters:

siteIdentifierType -

See Also:

getSiteIdentifierType()

getSiteIdentifierValue

String getSiteIdentifierValue()

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

Returns:

setSiteIdentifierValue

void setSiteIdentifierValue(String siteIdentifierValue)

Parameters:

siteIdentifierValue -

getProductionSandbox

SandBox getProductionSandbox()

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.

Returns:

setProductionSandbox

void setProductionSandbox(SandBox sandbox)

Sets the production sandbox. Typically configured via the database.

Parameters:

sandbox -

See Also:

getProductionSandbox();