Package lumis.portal.page.link
Class PageLinkConfig
- java.lang.Object
-
- lumis.portal.page.link.PageLinkConfig
-
- All Implemented Interfaces:
Cloneable
@StableMinor(version="14.2", sinceVersion="4.0") public class PageLinkConfig extends Object implements Cloneable
- Since:
- 4.0.0
- Version:
- $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $
-
-
Field Summary
Fields Modifier and Type Field Description static int
PAGE_LINK_TYPE_ADMINISTRATION
static int
PAGE_LINK_TYPE_ERROR_PAGE
static int
PAGE_LINK_TYPE_HOME_PAGE
static int
PAGE_LINK_TYPE_LOGIN
-
Constructor Summary
Constructors Constructor Description PageLinkConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addWebsiteBaseURL(IWebsiteBaseURL websiteBaseURL)
Adds an identifier of awebsite base URL
.protected PageLinkConfig
clone()
String
getCapabilities()
Returns the capabilities.String
getChannelId()
The channel id for a page link applies only to the type 0.String
getId()
String
getName()
Returns the name.String
getPageId()
int
getPriority()
Returns the priority of the page link.int
getType()
String
getWebsite()
Deprecated.Since 6.2.0 replaced bygetWebsiteObject()
.Collection<String>
getWebsiteBaseURLs()
Returns anunmodifiable collection
ofwebsite base URLs
associated with this page link.IWebsite
getWebsiteObject()
Returns the website object that contains all informations about the website and URLs.boolean
isUsesAllWebsiteBaseURLs()
Indicates whether all website base URLs will be used or not.void
setCapabilities(String capabilities)
Sets the capabilities.void
setChannelId(String channelId)
Sets the channel for the page link.void
setId(String id)
void
setName(String name)
Sets the namevoid
setPageId(String pageId)
void
setPriority(int priority)
Sets the priority.void
setType(int type)
protected void
setUsesAllWebsiteBaseURLs(boolean usesAllWebsiteBaseURLs)
Sets the usesAllWebsiteBaseURLs.void
setWebsite(String websiteStr)
Deprecated.Since 6.2.0 replaced by#setWebsiteObject(IWebsite)
void
setWebsite(IWebsite website)
Sets the websiteData.
-
-
-
Field Detail
-
PAGE_LINK_TYPE_LOGIN
public static final int PAGE_LINK_TYPE_LOGIN
- See Also:
- Constant Field Values
-
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
-
-
Method Detail
-
getId
public String getId()
- Returns:
- Returns the id.
-
setId
public void setId(String id)
- Parameters:
id
- The id to set.
-
getPageId
public String getPageId()
- Returns:
- Returns the pageId.
-
setPageId
public void setPageId(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.
-
getWebsite
@Deprecated public String getWebsite()
Deprecated.Since 6.2.0 replaced bygetWebsiteObject()
.This method returns the website main URL. To get other informations about the website use thegetWebsiteObject()
.Invoking this method is the same as
getWebsiteObject()
.getMainNonSecureBaseURL()
.toString()
.- Returns:
- Returns the website main URL.
-
setWebsite
@Deprecated public void setWebsite(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, anIllegalArgumentException
will be raised.- Parameters:
websiteStr
- The website main URL of the website target, that will be used on the page link.
-
getChannelId
public 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(String channelId)
Sets the channel for the page link.- Parameters:
channelId
- The channelId to set.- Since:
- 5.0.0
-
setCapabilities
public void setCapabilities(String capabilities)
Sets the capabilities.- Parameters:
capabilities
- the capabilities to store.- Throws:
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 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 totrue
, automatically clears the list ofURLs'
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
-
addWebsiteBaseURL
public void addWebsiteBaseURL(IWebsiteBaseURL websiteBaseURL)
Adds an identifier of awebsite base URL
.Automatically
set all website base URLs usage
tofalse
.- Parameters:
websiteBaseURL
- the website base URL.- Since:
- 6.2.0
-
getWebsiteBaseURLs
public Collection<String> getWebsiteBaseURLs()
Returns anunmodifiable collection
ofwebsite base URLs
associated with this page link.- Returns:
- an
unmodifiable collection
ofwebsite base URLs
associated with this page link. - Since:
- 6.2.0
-
setName
public void setName(String name)
Sets the name- Parameters:
name
- the name.- Since:
- 6.2.0
-
getName
public String getName()
Returns the name.- Returns:
- the name.
- Since:
- 6.2.0
-
clone
protected PageLinkConfig clone()
-
-