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

Interface PageRef

All Superinterfaces:
Comparable<StoreElement>, ContentProducer, HistoryProvider, IDProvider, PackagePoolItem, Previewable, Referenceable, StartNode, StoreElement, Workflowable
public interface PageRef extends StartNode, Referenceable, Previewable, ContentProducer, PackagePoolItem
This interface provides methods to handle the pagereferences in the SiteStore
Since:
3.0

  • Field Details

  • Method Details

    • getName

      @NotNull @Deprecated @NotNull String getName()
      Deprecated.
      since 4.1.10 - use getUid()
      Specified by:
      getName in interface StoreElement
      Since:
      3.0

    • getPageId

      long getPageId()
      Returns the id of the referenced Page.
      Returns:
      The id of the referenced Page
      Since:
      3.1.172
      See Also:

    • getPage

      @Nullable @Nullable Page getPage()
      Get the page from Page-Store of the current pagereference as object
      Returns:
      page of the reference
      Since:
      3.0

    • setPage

      void setPage(Page page)
      Set the page of the pagereference
      Parameters:
      page - new page of the pagereference
      Since:
      3.0

    • getPageGroupPosition

      int getPageGroupPosition()
      Get the position-number of the current pagereference in the pagegroup
      Returns:
      position-number of the pagereference in the pagegroup
      Since:
      3.0

    • getPageGroup

      @Nullable @Nullable PageGroup getPageGroup()
      Get the page-group of the current pagereference as object
      Returns:
      page-group of the pagereference
      Since:
      3.0

    • setPageGroup

      void setPageGroup(PageGroup group)
      Set the page-group of the pagereference
      Parameters:
      group - new page-group of the pagereference
      Since:
      3.0

    • getPageLangSpec

      PageLangSpec getPageLangSpec(Language language)
      Get the pagereference specification for the given language
      Returns:
      specification of the pagereference as object
      Since:
      3.0

    • getContent2Params

      @Nullable @Nullable Content2Params getContent2Params()
      Provides the content parameter object or null if the corresponding page has a new content section.
      Returns:
      The content parameters.
      Since:
      3.1.158

    • 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:

    • getUid

      @NotNull @NotNull String getUid()
      Get the unique referenec name of the pagereference.

      To use in a CMS_REF statement, the identifier must be prefixed with "pageref:".

      Specified by:
      getUid in interface IDProvider
      Returns:
      uniquedescription the reference name
      Since:
      4.0
      See Also:

    • getFilename

      @ApiDoc(comment="A filename suggestions which may be used for creating urls", since="3.0") @NotNull @NotNull String getFilename()
      Returns a filename suggestions which may be used for creating urls.
      Specified by:
      getFilename in interface ContentProducer
      Returns:
      a filename suggestion
      Since:
      3.0
      See Also:

    • setFilename

      void setFilename(String filename)
      Set a filename suggestions which may be used for creating urls.
      Since:
      3.0
      See Also:

    • getParentFolder

      SiteStoreFolder getParentFolder()
      Returns the page refs parent folder.
      Returns:
      The page refs parent folder.
      Since:
      3.0

    • save

      void save()
      Saves the node and all childs, shortcut for save(null, true).

      Use StoreElement.isLockSupported() to check if save operation is supported.

      Specified by:
      save in interface StoreElement
      Throws:
      DuplicateReferenceNameException - if a page ref with this getUid() already exists on the server
      Since:
      3.0
      See Also: