Package de.espirit.firstspirit.access.store.sitestore

Interface DocumentGroup

All Superinterfaces:
Comparable<StoreElement>, ContentProducer, HistoryProvider, IDProvider, Previewable, Referenceable, StoreElement, Workflowable
public interface DocumentGroup extends Referenceable, Previewable, ContentProducer
A DocumentGroup groups DocumentGroupLink's as their child nodes (see StoreElement.getChildren()).
Since:
3.0.54

  • Field Details

  • Method Details

    • getPrefixTemplate

      @Nullable @Nullable PageTemplate getPrefixTemplate()
      Get the template which is used to render the prefix, e.g. a table of contents
      Since:
      3.0.57

    • setPrefixTemplate

      void setPrefixTemplate(PageTemplate value)
      Set the template which is used to render the prefix, e.g. a table of contents
      Since:
      3.0.57

    • getSuffixTemplate

      @Nullable @Nullable PageTemplate getSuffixTemplate()
      Get the template which is used to render the suffix, e.g. an index
      Since:
      3.0.57

    • setSuffixTemplate

      void setSuffixTemplate(PageTemplate value)
      Set the template which is used to render the suffix, e.g. an index
      Since:
      3.0.57

    • getGenerateFor

      TemplateSet[] getGenerateFor()
      The template sets for which this document group should be generated
      Since:
      3.0.54

    • setGenerateFor

      void setGenerateFor(TemplateSet[] value)
      Defines to generate this group for the given list of template sets.
      Parameters:
      value - An array of template sets.
      Since:
      3.0.56

    • setGenerateForToAll

      void setGenerateForToAll()
      Defines to generate for all template sets.
      Since:
      3.0.57

    • getGenerateForAll

      boolean getGenerateForAll()
      Indicates, whether to generate for all template sets.
      Returns:
      true, if to generate for all.
      Since:
      3.0.57

    • getFilename

      @NotNull @NotNull String getFilename()
      Provides the file name of this group.
      Specified by:
      getFilename in interface ContentProducer
      Returns:
      The file name.
      Since:
      3.0.57

    • setFilename

      void setFilename(String value)
      Defines the file name for this group.
      Parameters:
      value - The file name.
      Since:
      3.0.57

    • getComment

      String getComment()
      Provides a comment for this group.
      Returns:
      A comment.
      Since:
      3.0.64

    • setComment

      void setComment(String value)
      Defines the comment for this group.
      Parameters:
      value - The comment.
      Since:
      3.0.64

    • getTemplateExtension

      String getTemplateExtension()
      Value of the extension used when resolving templates.
      Returns:
      The value.
      Since:
      3.0.57

    • setTemplateExtension

      void setTemplateExtension(String value)
      Defines the extension used for resolving templates.
      Parameters:
      value - The extension.
      Since:
      3.0.57

    • containsElement

      boolean containsElement(StoreElement element)
      Indicates whether the given element is part of this document group.
      Parameters:
      element - the element to test
      Returns:
      true if the provided element part this document group, either direct by a link or indirect by a link on one of its anchestores
      Throws:
      NullPointerException - when provided element is null
      Since:
      3.0.57

    • getDefaultTemplateSet

      TemplateSet getDefaultTemplateSet()
      Gives the default template set to be used.
      Returns:
      The default template set.
      Since:
      3.0.57

    • setDefaultTemplateSet

      void setDefaultTemplateSet(TemplateSet value)
      Defines the default template set to be used.
      Parameters:
      value - A template set.
      Since:
      3.0.57

    • addLink

      DocLink addLink(IDProvider target)
      Adds a link to the given target element.
      Parameters:
      target - The target element.
      Returns:
      A targetting link.
      Since:
      4.0

    • appendChild

      void appendChild(StoreElement child)
      Appends a child element to this group, which must be an instance of either DocLink whith a PageRef or SiteStoreFolder.
      Specified by:
      appendChild in interface StoreElement
      Parameters:
      child - The child element.
      Throws:
      IllegalArgumentException - if the child does not fulfills the restrictions above
      Since:
      3.0
      See Also:

    • appendChildBefore

      void appendChildBefore(@NotNull @NotNull StoreElement child, @Nullable @Nullable StoreElement before)
      Appends a child element to this group, inserting it before a reference element. The child to add must be an instance of either DocLink whith a PageRef or SiteStoreFolder.
      Specified by:
      appendChildBefore in interface StoreElement
      Parameters:
      child - The child element.
      before - The reference element.
      Throws:
      IllegalArgumentException - if the child does not fulfills the restrictions above
      Since:
      3.0.3
      See Also:

    • replaceChild

      void replaceChild(StoreElement oldChild, StoreElement newChild)
      Replaces a child element with another.
      Specified by:
      replaceChild in interface StoreElement
      Parameters:
      oldChild - The old child.
      newChild - The new child.
      Throws:
      IllegalArgumentException - if the new child does not fulfills the restrictions above
      Since:
      3.0.7
      See Also:

    • getUidType

      @NotNull @NotNull IDProvider.UidType getUidType()
      Return UID_TYPE.
      Specified by:
      getUidType in interface IDProvider
      Returns:
      the unique identifier
      Since:
      4.0.24
      See Also: