Package org.broadleafcommerce.common.site.domain

Interface Site

All Superinterfaces:
Serializable, Status
All Known Implementing Classes:
SiteImpl
public interface Site extends Serializable, Status
Created by bpolster.

  • Method Details

    • 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

      @Deprecated 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

      @Deprecated void setSiteIdentifierType(String siteIdentifierType)
      Deprecated.
      Use setSiteResolutionType(SiteResolutionType) Sets the site identifier type.
      Parameters:
      siteIdentifierType -
      See Also:

    • 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:

    • getCatalogs

      @Deprecated List<Catalog> getCatalogs()
      Deprecated.
      Not used by Broadleaf - scheduled to remove on or after 3.3
      Retrieve a list of product, category and offer groupings that this site has access to
      Returns:
      a list of catalog groupings

    • setCatalogs

      @Deprecated void setCatalogs(List<Catalog> catalogs)
      Deprecated.
      Not used by Broadleaf - scheduled to remove on or after 3.3
      Set the list of product, category and offer groupings that this site has access to
      Parameters:
      catalogs - a list of catalog groupings

    • getDefaultLocale

      Locale getDefaultLocale()
      used for default locale
      Returns:
      Locale

    • setDefaultLocale

      void setDefaultLocale(Locale defaultLocale)
      Sets the site default locale.
      Parameters:
      defaultLocale -

    • clone

      Site clone()
      Retrieve an deep copy of this site. Not bound by entity manager scope.
      Returns:
      a deep copy of this site

    • getArchiveStatus

      ArchiveStatus getArchiveStatus()

    • isDeactivated

      boolean isDeactivated()

    • setDeactivated

      void setDeactivated(boolean deactivated)

    • isTemplateSite

      @Deprecated boolean isTemplateSite()
      Deprecated.
      Not used by Broadleaf - scheduled to remove on or after 3.3
      This method will return true when the given site was created based on a template.
      Returns:
      whether or not this site is a TemplateSite