SeoRule

java.lang.Object
- lumis.service.seo.entity.SeoRule

```
public class SeoRule
extends Object
```
A content for Seo Rules

Since:

10.1.0

Version:

$Revision: 20412 $ $Date: 2017-07-20 19:55:43 +0000 (Thu, 20 Jul 2017) $

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SeoRule.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`SeoRule.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CACHE_REGION`
`static String`	`NAMED_QUERY_FIND_BY_CHANNELID`
`static String`	`NAMED_QUERY_FIND_BY_PAGEID`
`static String`	`NAMED_QUERY_FIND_BY_PAGEID_OR_CHANNELIDS`

Constructor Summary

Constructors
Constructor and Description

SeoRule()

Constructors
Constructor and Description
`SeoRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`URL`	`getCanonicalUrl()` Returns the canonical URL.
`String`	`getChannel()` Returns the identifier of the channel related to this rule.
`String`	`getId()` Returns the rule's identifier.
`String`	`getName()` Returns the rule's name.
`String`	`getPage()` Returns the identifier of the page related to this rule.
`String`	`getPageDescription()` Returns the page description.
`String`	`getPageTitle()` Returns the page title if defined.
`String`	`getPageTitlePattern()` Returns the page title pattern if defined.
`String`	`getSocialDescription()` Returns the social description.
`String`	`getSocialImage()` Returns the social image.
`String`	`getSocialTitle()` Returns the social title.
`SeoRule.Type`	`getType()` Returns the `SeoRule.Type` of rule.
`String`	`getUrlPath()` Returns the url path.
`void`	`setCanonicalUrl(URL canonicalUrl)` Sets the canonical URL.
`void`	`setChannel(String channel)` Sets the identifier of the channel related to this rule.
`void`	`setId(String id)` Sets the rule's identifier.
`void`	`setName(String name)` Sets the rule's name.
`void`	`setPage(String page)` Sets the identifier of the page related to this rule.
`void`	`setPageDescription(String pageDescription)` Sets the page description.
`void`	`setPageTitle(String pageTitle)` Sets the page title if defined.
`void`	`setPageTitlePattern(String pageTitlePattern)` Sets the page title if defined.
`void`	`setSocialDescription(String socialDescription)` Sets the social description.
`void`	`setSocialImage(String socialImage)` Sets the social image.
`void`	`setSocialTitle(String socialTitle)` Sets the social title.
`void`	`setType(SeoRule.Type type)` Sets the `SeoRule.Type` of rule.
`void`	`setUrlPath(String urlPath)` Sets the url path.

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

- Field Detail
  - NAMED_QUERY_FIND_BY_PAGEID
```
public static final String NAMED_QUERY_FIND_BY_PAGEID
```
    See Also:
    
    Constant Field Values
  - NAMED_QUERY_FIND_BY_CHANNELID
```
public static final String NAMED_QUERY_FIND_BY_CHANNELID
```
    See Also:
    
    Constant Field Values
  - NAMED_QUERY_FIND_BY_PAGEID_OR_CHANNELIDS
```
public static final String NAMED_QUERY_FIND_BY_PAGEID_OR_CHANNELIDS
```
    See Also:
    
    Constant Field Values
  - CACHE_REGION
```
public static final String CACHE_REGION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SeoRule
```
public SeoRule()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns the rule's identifier.
    
    Returns:
    
    the identifier.
    
    Since:
    
    10.1.0
  - setId
```
public void setId(String id)
```
    Sets the rule's identifier.
    
    Parameters:
    
    id - the identifier value to set.
    
    Since:
    
    10.1.0
  - getName
```
public String getName()
```
    Returns the rule's name.
    
    Returns:
    
    the name.
    
    Since:
    
    10.1.0
  - setName
```
public void setName(String name)
```
    Sets the rule's name.
    
    Parameters:
    
    name - the name value to set.
    
    Since:
    
    10.1.0
  - getType
```
public SeoRule.Type getType()
```
    Returns the SeoRule.Type of rule.
    
    Returns:
    
    the type.
    
    Since:
    
    10.1.0
  - setType
```
public void setType(SeoRule.Type type)
```
    Sets the SeoRule.Type of rule.
    
    Parameters:
    
    type - the type value to set.
    
    Since:
    
    10.1.0
  - getPage
```
public String getPage()
```
    Returns the identifier of the page related to this rule.
    
    Returns:
    
    the page identifier.
    
    Since:
    
    10.1.0
  - setPage
```
public void setPage(String page)
```
    Sets the identifier of the page related to this rule.
    
    Parameters:
    
    page - the page identifier to set.
    
    Since:
    
    10.1.0
  - getChannel
```
public String getChannel()
```
    Returns the identifier of the channel related to this rule.
    
    Returns:
    
    the channel identifier.
    
    Since:
    
    10.1.0
  - setChannel
```
public void setChannel(String channel)
```
    Sets the identifier of the channel related to this rule.
    
    Parameters:
    
    channel - the channel identifier to set.
    
    Since:
    
    10.1.0
  - getPageTitle
```
public String getPageTitle()
```
    Returns the page title if defined.
    
    Returns:
    
    the page title or null if no title is defined.
    
    Since:
    
    10.1.0
  - setPageTitle
```
public void setPageTitle(String pageTitle)
```
    Sets the page title if defined.
    
    Parameters:
    
    pageTitle - the page title value to set.
    
    Since:
    
    10.1.0
  - getPageTitlePattern
```
public String getPageTitlePattern()
```
    Returns the page title pattern if defined.
    
    Returns:
    
    the page title pattern or null if no title pattern is defined.
    
    Since:
    
    10.2.0
  - setPageTitlePattern
```
public void setPageTitlePattern(String pageTitlePattern)
```
    Sets the page title if defined.
    
    Parameters:
    
    pageTitle - the page title value to set.
    
    Since:
    
    10.2.0
  - getPageDescription
```
public String getPageDescription()
```
    Returns the page description.
    
    Returns:
    
    the page description or null if no description is defined.
    
    Since:
    
    10.1.0
  - setPageDescription
```
public void setPageDescription(String pageDescription)
```
    Sets the page description.
    
    Parameters:
    
    pageDescription - the page description value to set.
    
    Since:
    
    10.1.0
  - getUrlPath
```
public String getUrlPath()
```
    Returns the url path.
    
    Returns:
    
    the url path or null if no path is defined.
    
    Since:
    
    10.1.0
  - setUrlPath
```
public void setUrlPath(String urlPath)
```
    Sets the url path.
    
    Parameters:
    
    urlPath - the url path value to set.
    
    Since:
    
    10.1.0
  - getCanonicalUrl
```
public URL getCanonicalUrl()
```
    Returns the canonical URL.
    
    Returns:
    
    the canonical URL or null if no URL is defined.
    
    Since:
    
    10.1.0
  - setCanonicalUrl
```
public void setCanonicalUrl(URL canonicalUrl)
```
    Sets the canonical URL.
    
    Parameters:
    
    canonicalURL - the canonicalURL value to set.
    
    Since:
    
    10.1.0
  - getSocialTitle
```
public String getSocialTitle()
```
    Returns the social title.
    
    Returns:
    
    the social title or null if no title is defined.
    
    Since:
    
    10.1.0
  - setSocialTitle
```
public void setSocialTitle(String socialTitle)
```
    Sets the social title.
    
    Parameters:
    
    social - title the social title value to set.
    
    Since:
    
    10.1.0
  - getSocialDescription
```
public String getSocialDescription()
```
    Returns the social description.
    
    Returns:
    
    the social description or null if no description is defined.
    
    Since:
    
    10.1.0
  - setSocialDescription
```
public void setSocialDescription(String socialDescription)
```
    Sets the social description.
    
    Parameters:
    
    social - description the social description value to set.
    
    Since:
    
    10.1.0
  - getSocialImage
```
public String getSocialImage()
```
    Returns the social image.
    
    Returns:
    
    the social image or null if no image is defined.
    
    Since:
    
    10.1.0
  - setSocialImage
```
public void setSocialImage(String socialImage)
```
    Sets the social image.
    
    Parameters:
    
    social - image the social image value to set.
    
    Since:
    
    10.1.0

Class SeoRule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMED_QUERY_FIND_BY_PAGEID

NAMED_QUERY_FIND_BY_CHANNELID

NAMED_QUERY_FIND_BY_PAGEID_OR_CHANNELIDS

CACHE_REGION

Constructor Detail

SeoRule

Method Detail

getId

setId

getName

setName

getType

setType

getPage

setPage

getChannel

setChannel

getPageTitle

setPageTitle

getPageTitlePattern

setPageTitlePattern

getPageDescription

setPageDescription

getUrlPath

setUrlPath

getCanonicalUrl

setCanonicalUrl

getSocialTitle

setSocialTitle

getSocialDescription

setSocialDescription

getSocialImage

setSocialImage