Package de.espirit.firstspirit.access.store.templatestore

Interface PageTemplate

All Superinterfaces:
ChannelSourceProvider, Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, MasterTemplate, PackagePoolItem, PreviewImageProvider, Referenceable, RulesetContainer, RulesetContainer, SnippetContainer, StoreElement, Template, TemplateContentProvider, TemplateStoreElement, Workflowable
public interface PageTemplate extends MasterTemplate
Interface providing means to operate on page templates.
Since:
4.1.24

  • Field Details

  • Method Details

    • createAllowed

      Allowed createAllowed(@NotNull @NotNull String bodyName, @NotNull @NotNull Template template)
      Set a section or table template which should be allowed for this template for a given body
      Parameters:
      bodyName - name of a body in this template
      template - section or table template
      Since:
      3.0

    • createAllowed

      Allowed createAllowed(@NotNull @NotNull TemplateBody body, @NotNull @NotNull MasterTemplate template)
      Creates a new allowed node for the given section- or table template which should be allowed for the given body
      Parameters:
      body - the template body the given template should be allowed for
      template - the template which should be allowed for the given body
      Since:
      4.2.400

    • getAllowedTemplates

      List<Template> getAllowedTemplates(String bodyName)
      Get the list of section or table templates which are allowed for this template for a given body
      Parameters:
      bodyName - name of a body in this template
      Returns:
      list of allowed section templates
      Since:
      4.0

    • getAllowedTemplates

      List<MasterTemplate> getAllowedTemplates(@NotNull @NotNull TemplateBody templateBody)
      Get the list of section- or table templates which are allowed for this page template for the given template body.
      Note: If there aren't any allowed definitions for this pagetemplate, all existing section- and table templates will be returned.
      Parameters:
      templateBody - the template body to get the
      Since:
      4.2.400

    • isTemplateAllowed

      boolean isTemplateAllowed(@NotNull @NotNull TemplateBody templateBody, @NotNull @NotNull MasterTemplate template)
      Indicates whether the given template is allowed for the given body or not.
      Parameters:
      templateBody - the templateBody given template should be checked for
      template - the template to check if it is allowed
      Returns:
      true it template is allowed for templateBody, false otherwise.
      Since:
      5.0.100

    • getBodies

      @NotNull @NotNull List<? extends TemplateBody> getBodies()
      Returns the list of template bodies which are defined in this template.
      Returns:
      the list of template bodies
      Since:
      4.0
      See Also:

    • getBody

      @Nullable @Nullable TemplateBody getBody(String bodyName)
      Returns the template body specified by the given name or null if no body exists with the given name.
      Parameters:
      bodyName - the name specifying the body
      Returns:
      the template body specified by the given name or null
      Since:
      4.2.400

    • setBodies

      void setBodies(List<? extends TemplateBody> bodies)
      Set the list of bodies for this template.
      Parameters:
      bodies - the list of bodies
      Since:
      4.2.12
      See Also:

    • createTemplateBody

      TemplateBody createTemplateBody(String name)
      Create and add a new body.
      Since:
      4.2.12