Package lumis.portal.page.webresource

Class PageWebResourceData

  • @StableMinor(version="17.0",
             sinceVersion="5.0")
public class PageWebResourceData
extends java.lang.Object
    POJO for holding customizable data for a page web resource.
    Since:
    5.0.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.net.URL getCanonicalUrl()
      Returns the canonical link URL of the web resource.
      java.lang.String getDescription()
      Returns the page web resource description.
      java.util.List<java.lang.String> getKeywords()
      Returns the page web resource keywords.
      java.util.Map<java.lang.String,​java.lang.String> getMetaTags()
      Returns the page meta tags in a map.
      java.lang.String getSimpleTitle()
      Returns the page web resource simple title.
      It's important to notice that this title may not be the final title of the web resource.
      java.lang.String getTitle()
      Returns the page web resource title.
      java.lang.String getUrlPath()
      Returns the URL path.
      java.lang.String getUrlTitle()
      Returns the title value used for friendly URL generation of the web resource.
      void setCanonicalUrl​(java.net.URL canonicalUrl)
      Sets the URL to be used as the canonical link of the web resource.
      void setDescription​(java.lang.String description)
      Sets the page web resource description.
      void setKeywords​(java.util.List<java.lang.String> keywords)
      Sets the page web resource keywords.
      void setMetaTags​(java.util.Map<java.lang.String,​java.lang.String> metaTags)
      Sets the page meta tags map.
      void setSimpleTitle​(java.lang.String title)
      Sets the page web resource simple title.
      It's important to notice that this title may not be the final title of the web resource.
      void setTitle​(java.lang.String title)
      Sets the page web resource title.
      void setUrlPath​(java.lang.String urlPath)
      Sets the URL path.
      void setUrlTitle​(java.lang.String urlTitle)
      Sets the title value used during friendly URL generation of the web resource.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PageWebResourceData

        public PageWebResourceData()

    • Method Detail

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the page web resource title.
        Parameters:
        title - the title.
        Since:
        5.0.0

      • setSimpleTitle

        public void setSimpleTitle​(java.lang.String title)
        Sets the page web resource simple title.
        It's important to notice that this title may not be the final title of the web resource. The final web resource title will be calculated using title pattern, that may or may not include this title.
        Parameters:
        title - the simple title.
        Since:
        10.2.0

      • setUrlTitle

        public void setUrlTitle​(java.lang.String urlTitle)
        Sets the title value used during friendly URL generation of the web resource.
        Parameters:
        urlTitle - the value, or null if no specific title for URL generation was defined.
        Since:
        10.0.0

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the page web resource description.
        Parameters:
        description - the description.
        Since:
        5.0.0

      • setKeywords

        public void setKeywords​(java.util.List<java.lang.String> keywords)
        Sets the page web resource keywords.
        Parameters:
        keywords - the keywords. Must not be null. If no keywords is desired, an empty list may be used.
        Since:
        5.0.0

      • setMetaTags

        public void setMetaTags​(java.util.Map<java.lang.String,​java.lang.String> metaTags)
        Sets the page meta tags map.
        Parameters:
        metaTagMap - the new meta tags map.
        Since:
        6.0.0

      • setCanonicalUrl

        public void setCanonicalUrl​(java.net.URL canonicalUrl)
        Sets the URL to be used as the canonical link of the web resource.
        Parameters:
        canonicalUrl - the canonical URL, or null if this web resource does not have a canonical URL.
        Since:
        10.1.0

      • getTitle

        public java.lang.String getTitle()
        Returns the page web resource title.
        Returns:
        the title.
        Since:
        5.0.0

      • getSimpleTitle

        public java.lang.String getSimpleTitle()
        Returns the page web resource simple title.
        It's important to notice that this title may not be the final title of the web resource. The final web resource title will be calculated using title pattern, that may or may not include this title.
        Returns:
        the simple title.
        Since:
        10.2.0

      • getDescription

        public java.lang.String getDescription()
        Returns the page web resource description.
        Returns:
        the description.
        Since:
        5.0.0

      • getKeywords

        public java.util.List<java.lang.String> getKeywords()
        Returns the page web resource keywords.
        Returns:
        the keywords. Never returns null, but may return an empty list if there is no keyword.
        Since:
        5.0.0

      • getMetaTags

        public java.util.Map<java.lang.String,​java.lang.String> getMetaTags()
        Returns the page meta tags in a map.
        Returns:
        a map containing the page meta tags.
        Since:
        6.0.0

      • getUrlTitle

        public java.lang.String getUrlTitle()
        Returns the title value used for friendly URL generation of the web resource.
        Returns:
        the title value, or null if no specific title for URL generation was defined. In this case getSimpleTitle() should be used instead.
        Since:
        10.0.0

      • getCanonicalUrl

        public java.net.URL getCanonicalUrl()
        Returns the canonical link URL of the web resource.
        Returns:
        the canonical URL, or null if this web resource does not have a canonical URL.
        Since:
        10.1.0

      • getUrlPath

        public java.lang.String getUrlPath()
        Returns the URL path.
        Returns:
        the URL path.
        Since:
        12.5.0

      • setUrlPath

        public void setUrlPath​(java.lang.String urlPath)
        Sets the URL path.
        Parameters:
        urlPattern - the URL path.
        Since:
        12.5.0