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

Site	clone() Retrieve an deep copy of this site.
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.
String	getSiteIdentifierType() Deprecated. use getSiteResolutionType() Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site.
String	getSiteIdentifierValue() Used along with 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	isDeactivated()
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	setSiteIdentifierType(String siteIdentifierType) Deprecated. Use setSiteResolutionType(SiteResolutionType) Sets the site identifier type.
void	setSiteIdentifierValue(String siteIdentifierValue)
void	setSiteResolutionType(SiteResolutionType siteResolutionType) Sets the site resolution type.

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()

Deprecated. use getSiteResolutionType() Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site.

Returns:

setSiteIdentifierType

void setSiteIdentifierType(String siteIdentifierType)

Deprecated. Use setSiteResolutionType(SiteResolutionType) Sets the site identifier type.

Parameters:

siteIdentifierType -

See Also:

getSiteIdentifierType()

getSiteIdentifierValue

String getSiteIdentifierValue()

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

Returns:

setSiteIdentifierValue

void setSiteIdentifierValue(String siteIdentifierValue)

Parameters:

siteIdentifierValue -

getSiteResolutionType

SiteResolutionType getSiteResolutionType()

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

Returns:

setSiteResolutionType

void setSiteResolutionType(SiteResolutionType siteResolutionType)

Sets the site resolution type.

Parameters:

siteResolutionType -

See Also:

getSiteResolutionType()

getCatalogs

List<Catalog> getCatalogs()

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

Returns:

a list of catalog groupings

setCatalogs

void setCatalogs(List<Catalog> catalogs)

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

Parameters:

catalogs - a list of catalog groupings

clone

Site clone()

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

Returns:

a deep copy of this site

isDeactivated

boolean isDeactivated()

setDeactivated

void setDeactivated(boolean deactivated)