Interface TemplateSet


public interface TemplateSet
A template set
Since:
3.0
  • Field Details

  • Method Details

    • getUid

      String getUid()
      Returns the unique identifier of this TemplateSet.
      Returns:
      the uid of this TemplateSet
      Since:
      4.2.12
      See Also:
    • setUid

      void setUid(String name)
      Sets the unique identifier of this TemplateSet.
      Since:
      4.2.12
      See Also:
    • getDisplayName

      @Nullable String getDisplayName(Language language)
      Gets display name of the TemplateSet for the given language.
      Parameters:
      language -
      Returns:
      the name or null if not defined
      Since:
      4.2.12
    • setDisplayName

      void setDisplayName(Language language, String displayName)
      Sets the display name of the TemplateSet for the given language
      Parameters:
      displayName - the new displayname
      language - the language to set the display name for
      Since:
      4.2.12
    • getDescription

      @Nullable String getDescription(Language language)
      Get the editorial description of this TemplateSet for the given language or null if not defined for the language
      Parameters:
      language - the language to get the description for
      Returns:
      the description for the given language if defined, null otherwise
      Since:
      4.2.12
    • setDescription

      void setDescription(Language language, String description)
      Sets the editorial description of this TemplateSet for the given language
      Parameters:
      description - the new description
      language - the language to set the description for
      Since:
      4.2.12
    • getExtension

      String getExtension()
      Gets the extension of the TemplateSet
      Returns:
      the extension value
      Since:
      3.0
    • setExtension

      void setExtension(String extension)
      Sets the extension of the TemplateSet
      Parameters:
      extension - the new extension
      Since:
      3.0
    • getPresentationChannelName

      @Nullable String getPresentationChannelName()
      Gets the name of the presentation channel of the template set
      Returns:
      the presentation channel name
      Since:
      3.0
    • setPresentationChannel

      void setPresentationChannel(String channelName)
      Sets the PresentationChannel of the TemplateSet
      Parameters:
      channelName - the PresentationChannel identified by its name
      Since:
      3.0
    • getPresentationChannel

      @Nullable PresentationChannel getPresentationChannel()
      Gets the PresentationChannel of this TemplateSet
      Returns:
      PresentationChannel of this TemplateSet
      Since:
      4.0
    • setPresentationChannelId

      void setPresentationChannelId(long channel)
      Defines the presentation channel of this template set.
      Parameters:
      channel - The presentation channel id.
      Since:
      4.0
    • isActive

      boolean isActive()
      Is this TemplateSet active
      Returns:
      is active
      Since:
      3.0
    • setActive

      void setActive(boolean active)
      Activate or deactivate the TemplateSet
      Parameters:
      active - activate/deactivate
      Since:
      3.0
    • setConversionTable

      void setConversionTable(String tableName)
      Sets the conversion table of the template set
      Parameters:
      tableName - the name of the conversion table
      Since:
      3.0
    • setConversionTable

      void setConversionTable(ConversionTable table)
      Defines the conversion table to be used with this template set.
      Parameters:
      table - The conversion table.
      Since:
      4.0
    • getConversionTable

      ConversionTable getConversionTable()
      Provides the conversion table to be used with this template set.
      Returns:
      The conversion table.
      Since:
      4.0
    • getTemplateSetConversionTable

      String getTemplateSetConversionTable()
      Gets the conversion table of the template set
      Returns:
      the name of the conversion table
      Since:
      3.0
    • getId

      long getId()
      Provides the ID for this template set.
      Returns:
      The ID.
      Since:
      4.0
    • getLinefeed

      String getLinefeed()
      Not evaluated by FirstSpirit. May be used in ContentProcessor implementations.
      Since:
      4.0
    • setLinefeed

      void setLinefeed(String linefeed)
      Not evaluated by FirstSpirit. May be used in ContentProcessor implementations.
      Since:
      4.0
    • setUseWebeditForPreview

      @Deprecated void setUseWebeditForPreview(boolean useWebedit)
      Deprecated.
      since 5.0.302 - no replacement
      Defines to use this template set for webedit based previews.
      Parameters:
      useWebedit - true, to use as preview.
      Since:
      4.0
    • isUseWebeditForPreview

      @Deprecated boolean isUseWebeditForPreview()
      Deprecated.
      since 5.0.302 - no replacement
      Indicates whether to use this template set for webedit based previews.
      Returns:
      true, if used for preview.
      Since:
      4.0
    • isTemplateInspectionEnabled

      boolean isTemplateInspectionEnabled()
      Returns whether or not the template inspection is enabled for this template set. If enabled, the preview generation will try to enhance the generated html code with template related attributes. This only works for html based template sets.
      Returns:
      template inspection enabled state
      Since:
      5.1.304
    • setTemplateInspectionEnabled

      void setTemplateInspectionEnabled(boolean enabled)
      Enables or disables the template inspection for this template set. If enabled, the preview generation will try to enhance the generated html code with template related attributes. This only works for html based template sets.
      Parameters:
      enabled - template inspection enabled state
      Since:
      5.1.304