Package lumis.portal.page.link

Class PageLinkConfig

  • All Implemented Interfaces:
    java.lang.Cloneable
    @StableMinor(version="16.1",
             sinceVersion="4.0")
public class PageLinkConfig
extends java.lang.Object
implements java.lang.Cloneable
    Since:
    4.0.0
    Version:
    $Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

    • Field Detail

      • PAGE_LINK_TYPE_HOME_PAGE

        public static final int PAGE_LINK_TYPE_HOME_PAGE
        See Also:
        Constant Field Values

      • PAGE_LINK_TYPE_ADMINISTRATION

        public static final int PAGE_LINK_TYPE_ADMINISTRATION
        See Also:
        Constant Field Values

      • PAGE_LINK_TYPE_ERROR_PAGE

        public static final int PAGE_LINK_TYPE_ERROR_PAGE
        See Also:
        Constant Field Values

    • Constructor Detail

      • PageLinkConfig

        public PageLinkConfig()

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns:
        Returns the id.

      • setId

        public void setId​(java.lang.String id)
        Parameters:
        id - The id to set.

      • getPageId

        public java.lang.String getPageId()
        Returns:
        Returns the pageId.

      • setPageId

        public void setPageId​(java.lang.String pageId)
        Parameters:
        pageId - The pageId to set.

      • getType

        public int getType()
        Returns:
        Returns the type.

      • setType

        public void setType​(int type)
        Parameters:
        type - The type to set.

      • setWebsite

        @Deprecated
public void setWebsite​(java.lang.String websiteStr)
        Deprecated.
        Since 6.2.0 replaced by #setWebsiteObject(IWebsite)
        This method defines the website to the page link. The website must exist previously on database.

        The website will be identified by the main URL defined on the Website Administration. If not found one website that the main URL match with the website parameter, an IllegalArgumentException will be raised.
        Parameters:
        websiteStr - The website main URL of the website target, that will be used on the page link.

      • getChannelId

        public java.lang.String getChannelId()
        The channel id for a page link applies only to the type 0.
        Returns:
        Returns the channelId
        Since:
        5.0.0

      • setChannelId

        public void setChannelId​(java.lang.String channelId)
        Sets the channel for the page link.
        Parameters:
        channelId - The channelId to set.
        Since:
        5.0.0

      • setCapabilities

        public void setCapabilities​(java.lang.String capabilities)
        Sets the capabilities.
        Parameters:
        capabilities - the capabilities to store.
        Throws:
        java.lang.IllegalArgumentException - if the given capabilities is an invalid EL.
        Since:
        6.0.0

      • setPriority

        public void setPriority​(int priority)
        Sets the priority.
        Parameters:
        priority - the priority to store.
        Since:
        6.0.0

      • getCapabilities

        public java.lang.String getCapabilities()
        Returns the capabilities.
        Returns:
        the capabilities.
        Since:
        6.0.0

      • getPriority

        public int getPriority()
        Returns the priority of the page link.
        Returns:
        the priority.

      • setWebsite

        public void setWebsite​(IWebsite website)
        Sets the websiteData.
        Parameters:
        website - the website value to set.
        Since:
        6.2.0

      • getWebsiteObject

        public IWebsite getWebsiteObject()
        Returns the website object that contains all informations about the website and URLs.
        Returns:
        the the website object that contains all informations about the website and URLs.
        Since:
        6.2.0

      • setUsesAllWebsiteBaseURLs

        protected void setUsesAllWebsiteBaseURLs​(boolean usesAllWebsiteBaseURLs)
        Sets the usesAllWebsiteBaseURLs.

        When the parameter usesAllWebsiteBaseURLs is set to true, automatically clears the list of URLs' identifiers associated with this page link.

        Parameters:
        usesAllWebsiteBaseURLs - the usesAllWebsiteBaseURLs value to set.
        Since:
        6.2.0

      • isUsesAllWebsiteBaseURLs

        public boolean isUsesAllWebsiteBaseURLs()
        Indicates whether all website base URLs will be used or not.
        Returns:
        the true if all website base URLs will are used, otherwise false.
        Since:
        6.2.0

      • getWebsiteBaseURLs

        public java.util.Collection<java.lang.String> getWebsiteBaseURLs()
        Returns an unmodifiable collection of website base URLs associated with this page link.
        Returns:
        an unmodifiable collection of website base URLs associated with this page link.
        Since:
        6.2.0

      • setName

        public void setName​(java.lang.String name)
        Sets the name
        Parameters:
        name - the name.
        Since:
        6.2.0

      • getName

        public java.lang.String getName()
        Returns the name.
        Returns:
        the name.
        Since:
        6.2.0

      • clone

        protected PageLinkConfig clone()
        Overrides:
        clone in class java.lang.Object