Package de.espirit.firstspirit.access.store.pagestore

Interface Page

All Superinterfaces:
Comparable<StoreElement>, ContentProducer, DataProvider, HistoryProvider, IDProvider, PackagePoolItem, Previewable, StoreElement, TemplateProvider<PageTemplate>, Workflowable
All Known Subinterfaces:
GCAPage
public interface Page extends DataProvider, IDProvider, ContentProducer, TemplateProvider<PageTemplate>, Previewable, PackagePoolItem
This interface provides methods to handle the Pages in the PageStore
Since:
3.0

  • Field Details

  • Method Details

    • getName

      @NotNull @Deprecated @NotNull String getName()
      Deprecated.
      since 4.1.10 - use IDProvider.getUid()
      Get the unique name of the Page
      Specified by:
      getName in interface StoreElement
      Returns:
      unique name of the Page
      Since:
      3.0

    • getTemplate

      @NotNull @NotNull PageTemplate getTemplate()
      Returns the template of this element.
      Specified by:
      getTemplate in interface TemplateProvider<PageTemplate>
      Returns:
      the template of type <T>
      Since:
      3.0

    • setTemplate

      void setTemplate(@NotNull @NotNull PageTemplate pageTemplate)
      Set the template for this page.
      Parameters:
      pageTemplate - template this page should base on
      Throws:
      NullPointerException - if pageTemplate is null
      Since:
      4.1.25

    • getBodyByName

      Body getBodyByName(String bodyName)
      Searches for the body with the given name in this page.
      Parameters:
      bodyName - - the name of the body
      Returns:
      Body - the body or null if no body exists with the given name
      Since:
      3.0

    • isArchivePage

      boolean isArchivePage()
      Generate archived version of this page
      Returns:
      should archived versions be generated
      Since:
      3.0

    • setArchive

      void setArchive(boolean archive)
      Set generate archived version of this page.
      Parameters:
      archive - Generate archived version of this page
      Since:
      3.0

    • getPageRefs

      @NotNull @NotNull Collection<PageRef> getPageRefs()
      Get the Collection of PageRefs that are using this page.
      Returns:
      a Collection of PageRefs that are using this page.
      Since:
      5.2.211003

    • addTranslated

      void addTranslated(Language language)
      Adds the given language to the list of translated languages.
      Parameters:
      language - Language to add
      Since:
      3.0
      See Also:

    • removeTranslated

      void removeTranslated(Language language)
      Removes the given language from the list of translated languages.
      Parameters:
      language - Language to remove
      Since:
      3.0
      See Also:

    • isTranslated

      boolean isTranslated(Language language)
      Tests if this page is translated for the given language.
      Parameters:
      language - Language to check translation for
      Returns:
      true if this page is translated for the given language
      Since:
      3.0
      See Also: