PageLinkConfig

java.lang.Object
- lumis.portal.page.link.PageLinkConfig

All Implemented Interfaces:: Cloneable

@StableMinor(version="12.3",
             sinceVersion="4.0")
public class PageLinkConfig
extends Object
implements Cloneable

Since:: 4.0.0
Version:: $Revision: 23746 $ $Date: 2020-04-07 23:14:34 +0000 (Tue, 07 Apr 2020) $

Field Summary

Fields
Modifier and Type	Field and 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 and Description

PageLinkConfig()

Constructors
Constructor and Description
`PageLinkConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addWebsiteBaseURL(IWebsiteBaseURL websiteBaseURL)` Adds an identifier of a `website 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 by `getWebsiteObject()`.
`Collection<String>`	`getWebsiteBaseURLs()` Returns an `unmodifiable collection` of `website 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 name
`void`	`setPageId(String pageId)`
`void`	`setPriority(int priority)` Sets the priority.
`void`	`setType(int type)`
`protected void`	`setUsesAllWebsiteBaseURLs(boolean usesAllWebsiteBaseURLs)` Sets the usesAllWebsiteBaseURLs.
`void`	`setWebsite(IWebsite website)` Sets the websiteData.
`void`	`setWebsite(String websiteStr)` Deprecated. Since 6.2.0 replaced by `#setWebsiteObject(IWebsite)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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
- Constructor Detail
  - PageLinkConfig
```
public PageLinkConfig()
```
- 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 by getWebsiteObject().
    
    This method returns the website main URL. To get other informations about the website use the getWebsiteObject().
    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, 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 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 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
  - addWebsiteBaseURL
```
public void addWebsiteBaseURL(IWebsiteBaseURL websiteBaseURL)
```
    Adds an identifier of a website base URL.
    Automatically set all website base URLs usage to false.
    
    Parameters:
    
    websiteBaseURL - the website base URL.
    
    Since:
    
    6.2.0
  - getWebsiteBaseURLs
```
public Collection<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(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()
```
    Overrides:
    
    clone in class Object

Class PageLinkConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAGE_LINK_TYPE_LOGIN

PAGE_LINK_TYPE_HOME_PAGE

PAGE_LINK_TYPE_ADMINISTRATION

PAGE_LINK_TYPE_ERROR_PAGE

Constructor Detail

PageLinkConfig

Method Detail

getId

setId

getPageId

setPageId

getType

setType

getWebsite

setWebsite

getChannelId

setChannelId

setCapabilities

setPriority

getCapabilities

getPriority

setWebsite

getWebsiteObject

setUsesAllWebsiteBaseURLs

isUsesAllWebsiteBaseURLs

addWebsiteBaseURL

getWebsiteBaseURLs

setName

getName

clone