lumis.portal.page.webresource

Class PageWebResourceData

java.lang.Object

lumis.portal.page.webresource.PageWebResourceData

@StableMinor(version="12.3",
             sinceVersion="5.0")
public class PageWebResourceData
extends Object

POJO for holding customizable data for a page web resource.

Since:

5.0.0

Version:

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

Constructor Summary

Constructors

Constructor and Description
PageWebResourceData()

Method Summary

Modifier and Type	Method and Description
URL	getCanonicalUrl() Returns the canonical link URL of the web resource.
String	getDescription() Returns the page web resource description.
List<String>	getKeywords() Returns the page web resource keywords.
Map<String,String>	getMetaTags() Returns the page meta tags in a map.
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.
String	getTitle() Returns the page web resource title.
String	getUrlTitle() Returns the title value used for friendly URL generation of the web resource.
void	setCanonicalUrl(URL canonicalUrl) Sets the URL to be used as the canonical link of the web resource.
void	setDescription(String description) Sets the page web resource description.
void	setKeywords(List<String> keywords) Sets the page web resource keywords.
void	setMetaTags(Map<String,String> metaTags) Sets the page meta tags map.
void	setSimpleTitle(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(String title) Sets the page web resource title.
void	setUrlTitle(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(String title)

Sets the page web resource title.

Parameters:

title - the title.

Since:

5.0.0

setSimpleTitle

public void setSimpleTitle(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(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(String description)

Sets the page web resource description.

Parameters:

description - the description.

Since:

5.0.0

setKeywords

public void setKeywords(List<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(Map<String,String> metaTags)

Sets the page meta tags map.

Parameters:

metaTagMap - the new meta tags map.

Since:

6.0.0

setCanonicalUrl

public void setCanonicalUrl(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 String getTitle()

Returns the page web resource title.

Returns:

the title.

Since:

5.0.0

getSimpleTitle

public 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 String getDescription()

Returns the page web resource description.

Returns:

the description.

Since:

5.0.0

getKeywords

public List<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 Map<String,String> getMetaTags()

Returns the page meta tags in a map.

Returns:

a map containing the page meta tags.

Since:

6.0.0

getUrlTitle

public 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 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