Package de.hybris.platform.site

Interface BaseSiteService

  • All Known Implementing Classes:
    DefaultBaseSiteService
    public interface BaseSiteService
    CMS unaware site related service
    Since:
    4.5
    Spring Bean ID:
    baseSiteService

    • Method Detail

      • getAllBaseSites

        java.util.Collection<BaseSiteModel> getAllBaseSites()
        Returns all BaseSite instances.
        Returns:
        all BaseSite instances

      • getBaseSiteForUID

        BaseSiteModel getBaseSiteForUID​(java.lang.String siteUid)
        Returns site for the given site uid.
        Parameters:
        siteUid - the site's uid
        Returns:
        the current site

      • getCurrentBaseSite

        BaseSiteModel getCurrentBaseSite()
        Returns current site from the session for current user.
        Returns:
        the current site

      • setCurrentBaseSite

        void setCurrentBaseSite​(BaseSiteModel baseSiteModel,
                        boolean activateAdditionalSessionAdjustments)
        Sets the given site as current and possibly performs an additional ActivateBaseSiteInSessionStrategy.activate(BaseSiteModel) logic
        Parameters:
        baseSiteModel - The base site to set as the current site in the session
        activateAdditionalSessionAdjustments - - boolean indicating whether session adjustments should be applied
        Throws:
        BaseSiteActivationException - if activation failed, might occur if activateAdditionalSessionAdjustments is true

      • setCurrentBaseSite

        void setCurrentBaseSite​(java.lang.String siteUid,
                        boolean activateAdditionalSessionAdjustments)
        Sets the given site as current and possibly performs an additional ActivateBaseSiteInSessionStrategy.activate(BaseSiteModel) logic
        Parameters:
        siteUid - The base site siteUid to load and set as the current site in the session
        activateAdditionalSessionAdjustments - - boolean indicating whether session adjustments should be applied
        Throws:
        BaseSiteActivationException - if activation failed, might occur if activateAdditionalSessionAdjustments is true

      • getProductCatalogs

        java.util.List<CatalogModel> getProductCatalogs​(BaseSiteModel site)
        Gets the product catalogs for BaseSiteModel object.
        Parameters:
        site - the BaseSiteModel object for which catalogs will be obtained.
        Returns:
        the list of CatalogModel objects.