Package com.broadleafcommerce.data.tracking.core.filtering.domain

Interface CatalogBasicInfo

public interface CatalogBasicInfo
A simple interface intended to expose the minimal pertinent details about a multitenant Catalog.
Author:
Samarth Dhruva (samarthd)
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContextId()
    A soft reference for the catalog id.
    Long
    getLevel()
    Sorting level used to determine closest catalog visibility to the caller's context
    Locale
    getLocale()
    Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
    String
    getName()
    The catalog's name.
    void
    setContextId(String contextId)
    A soft reference for the catalog id.
    void
    setLevel(Long level)
    Sorting level used to determine closest catalog visibility to the caller's context
    void
    setLocale(Locale locale)
    Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
    void
    setName(String name)
    The catalog's name.

  • Method Details

    • getContextId

      String getContextId()
      A soft reference for the catalog id. Multitenant hierarchies for applications and catalogs are maintained separately in the multitenant microservice.
      Returns:
      The soft reference to the catalog id

    • setContextId

      void setContextId(String contextId)
      A soft reference for the catalog id. Multitenant hierarchies for applications and catalogs are maintained separately in the multitenant microservice.
      Parameters:
      contextId - The soft reference to the catalog id

    • getName

      String getName()
      The catalog's name.
      Returns:
      the name of the catalog

    • setName

      void setName(String name)
      The catalog's name.
      Parameters:
      name - the name of the catalog

    • getLocale

      Locale getLocale()
      Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
      Returns:
      the Locale that all items within this catalog apply to

    • setLocale

      void setLocale(Locale locale)
      Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
      Parameters:
      locale - the Locale that all items within this catalog apply to

    • getLevel

      Long getLevel()
      Sorting level used to determine closest catalog visibility to the caller's context
      Returns:
      Sorting level

    • setLevel

      void setLevel(Long level)
      Sorting level used to determine closest catalog visibility to the caller's context
      Parameters:
      level - Sorting level