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

Interface PageLangSpec

All Superinterfaces:
Comparable<StoreElement>, StoreElement, Workflowable
public interface PageLangSpec extends StoreElement
This interface provides methods to handle the PageSpecification (language dependent properties of a site at SiteStore)
Since:
3.0

  • Method Details

    • getName

      @NotNull @NotNull String getName()
      Get the name of the pagereference
      Specified by:
      getName in interface StoreElement
      Returns:
      name of the pagereference
      Since:
      3.0

    • setName

      void setName(String name)
      Set the name of the pagereference
      Parameters:
      name - new name of the pagereference
      Since:
      3.0

    • getLanguage

      Language getLanguage()
      Get the language of the pagereference
      Returns:
      language of the pagereference
      Since:
      3.0

    • getShowInPageGroup

      boolean getShowInPageGroup()
      State if this pagereference shold be shown at the PageGroup
      Returns:
      false - hidden; true - visible
      Since:
      3.0

    • setShowInPageGroup

      void setShowInPageGroup(boolean show)
      Set the state if this pagereference shold be shown in the PageGroup
      Parameters:
      show - false - hide; true - show
      Since:
      3.0

    • getKeywords

      String getKeywords()
      Gets the keywords of this pagereference.
      Returns:
      String the keywords or null if no keywords set
      Since:
      3.0.106

    • setKeywords

      void setKeywords(String keywords)
      Sets the keywords for this pagereference for the underlying language of this PageLangSpec.
      Parameters:
      keywords - the new keywords for this PageLangSpec
      Since:
      3.0.106

    • getShowInSiteMap

      boolean getShowInSiteMap()
      State if this pagereference shold be shown at the SiteMap
      Returns:
      false - hidden; true - visible
      Since:
      3.0

    • setShowInSiteMap

      void setShowInSiteMap(boolean show)
      Set the state if this menu shold be shown at the pagereference
      Parameters:
      show - false - hide; true - show
      Since:
      3.0

    • getSiteMapLabel

      @Nullable @Nullable String getSiteMapLabel()
      Get the sitemap label of this pageref.
      Returns:
      sitemaplabel
      Since:
      3.0.98

    • setSiteMapLabel

      void setSiteMapLabel(String label)
      Set the label of the sitemap
      Parameters:
      label - the sitemap label
      Since:
      3.0.82

    • hasSiteMapPictureRef

      boolean hasSiteMapPictureRef()
      Indicates whether the site map picture is set.
      Returns:
      true if a site map picture is set
      Since:
      3.1.170
      See Also:

    • getSiteMapPicture

      @Nullable @Nullable Picture getSiteMapPicture()
      Gets the sitemap picture of this pageref.
      Returns:
      Picture sitemappicture or null if no picture is set or the reference name is invalid
      Since:
      3.0.104
      See Also:

    • getSiteMapPictureRef

      @Nullable @Nullable String getSiteMapPictureRef()
      Provides the reference string for the site map picture, e.g. "media:logo" or null, if no site map picture is specified.
      Returns:
      The reference string or null.
      Since:
      3.1.170
      See Also:

    • setSiteMapPicture

      void setSiteMapPicture(@Nullable @Nullable Picture picture)
      Sets the sitemap picture for this pagereference.
      Parameters:
      picture - the new sitemap picture
      Since:
      3.0.104
      See Also:

    • setSiteMapPictureRef

      void setSiteMapPictureRef(String ref)
      Sets the sitemap picture as string reference.
      Since:
      4.0

    • getUrl

      String getUrl()
      Get the external URL of the pagereference
      Returns:
      external URL of the pagereference
      Since:
      3.0

    • setUrl

      void setUrl(String url)
      Set the external URL of the pagereference
      Parameters:
      url - new external URL for the pagereference
      Since:
      3.0

    • useInternalUrl

      boolean useInternalUrl()
      State if this pagereference use an internal URL. Using internal url is the default state.
      To set useInternalUrl call setUseExternalUrl(boolean) or setUseRelatedProjectUrl(boolean) with false
      Returns:
      false - don't use; true - use
      Since:
      3.0.106

    • useRelatedProjectUrl

      boolean useRelatedProjectUrl()
      State if this pagereference use an URL from a releated project.
      Returns:
      false - don't use; true - use
      Since:
      3.0.106

    • setUseRelatedProjectUrl

      void setUseRelatedProjectUrl(boolean useRelated)
      State if this pagereference should use an URL to a related project. If called with false pagereference will use internal URL (default mode).
      Parameters:
      useRelated - false -> don't use; true -> use
      Since:
      3.0.106

    • useExternalUrl

      boolean useExternalUrl()
      State if this pagereference should use an external URL
      Returns:
      false - don't use; true - use
      Since:
      3.0

    • setUseExternalUrl

      void setUseExternalUrl(boolean useExternal)
      Set the state if this pagereference should use an external URL. If called with false pagereference will use internal URL (default mode).
      Parameters:
      useExternal - false -> don't use; true -> use
      Since:
      3.0.103

    • createScheduledPageRef

      @NotNull @NotNull de.espirit.firstspirit.store.access.sitestore.AltPageRefImpl createScheduledPageRef(@NotNull @NotNull Page page, @NotNull @NotNull Date validFrom)
      Creates and adds a scheduled page-ref.
      Parameters:
      page - page from PageStore that should be taken as an scheduled alternative.
      validFrom - date from that the new page will be valid.
      Returns:
      created scheduled page-ref.
      Since:
      4.2.400

    • getScheduledPageRefs

      @NotNull @NotNull List<AltPageRef> getScheduledPageRefs()
      Returns a modifiable list of scheduled page-refs.
      Returns:
      modifiable list of alternative page-refs.
      Since:
      4.2.400
      See Also:

    • getRemoteProjectConfiguration

      @Nullable @Nullable RemoteProjectConfiguration getRemoteProjectConfiguration()
      Return RemoteProjectConfiguration used for related project.
      Since:
      4.0

    • setRemoteProjectConfiguration

      void setRemoteProjectConfiguration(@Nullable @Nullable RemoteProjectConfiguration configuration)
      Set RemoteProjectConfiguration used for releated project.
      Since:
      4.0