Package com.broadleafcommerce.theme.domain

Interface ThemeDefinition

All Superinterfaces:
org.broadleafcommerce.common.copy.MultiTenantCloneable<ThemeDefinition>, Serializable
All Known Implementing Classes:
ThemeDefinitionImpl
public interface ThemeDefinition extends Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<ThemeDefinition>
A ThemeDefinition describes a certain theme, including where on the file system it lives, what fields are configurable, etc. In conjunction with a ThemeConfiguration, it provides a wholistic view of what is necessary to render a theme.
Author:
Andre Azzolini (apazzolini)

  • Method Details

    • getId

      Long getId()
      Returns the id for this theme definition.
      Returns:

    • setId

      void setId(Long id)
      Sets the unique id for this theme definition
      Parameters:
      id -

    • getThemeName

      String getThemeName()
      Returns the name of this theme
      Returns:

    • setThemeName

      void setThemeName(String templateName)
      Sets the name of this theme.
      Parameters:
      templateName -

    • getThemeDescription

      String getThemeDescription()
      Returns a description of this theme.
      Returns:

    • setThemeDescription

      void setThemeDescription(String templateDescription)
      Sets a description of this theme.
      Parameters:
      templateDescription -

    • getThemePath

      String getThemePath()
      The path prefix that will be used to resolve this theme.
      Returns:

    • setThemePath

      void setThemePath(String themePath)
      Sets the path prefix that will be used to resolve this theme.
      Parameters:
      themePath -

    • getFieldGroupsXref

      List<ThemeDefinitionFieldGroupXref> getFieldGroupsXref()
      The list of configurable fields supported by this theme.
      Returns:

    • setFieldGroupsXref

      void setFieldGroupsXref(List<ThemeDefinitionFieldGroupXref> fieldGroups)
      Sets the list of configurable fields supported by this theme
      Parameters:
      fieldGroups -

    • isDefaultDefinition

      boolean isDefaultDefinition()
      Returns:
      whether or not this definition is the default

    • setDefaultDefinition

      void setDefaultDefinition(boolean defaultDefinition)
      Sets the default flag
      Parameters:
      defaultDefinition -