PageCacheConfig

java.lang.Object
- lumis.portal.page.cache.PageCacheConfig

```
public class PageCacheConfig
extends Object
```
Stores information about the caching of a page.

Since:

4.0.0

Version:

$Revision: 20509 $ $Date: 2017-09-11 19:18:14 +0000 (Mon, 11 Sep 2017) $

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_INITIAL_PRIORITY` Maximum priority value for `getInitialPriority()`.
`static int`	`MIN_INITIAL_PRIORITY` Minimum priority value for `getInitialPriority()`.
`static int`	`STATUS_DISABLED` Status that indicates the cache is disabled.
`static int`	`STATUS_GENERATING` Status that indicates the cache being generated.
`static int`	`STATUS_GENERATING_OUTDATED` Status that indicates the cache is being generated, but the generation result will be outdated, because something changed after the generation started.
`static int`	`STATUS_NOT_PUBLISHED` Status that indicates the target page is not published (its target content is not published).
`static int`	`STATUS_OUTDATED` Status that indicates the cache is outdated.
`static int`	`STATUS_OUTDATED_WITH_ERROR` Status that indicates the cache is outdated and has quit generating due to errors.
`static int`	`STATUS_UPDATED` Status that indicates the cache is updated.

Constructor Summary

Constructors
Constructor and Description

PageCacheConfig(WebResource webResource)
Creates a PageCacheConfig for a web resource.

Constructors
Constructor and Description
`PageCacheConfig(WebResource webResource)` Creates a `PageCacheConfig` for a web resource.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getFilePath()` Returns the path to the cache file, relative to the portal application web root.
`String`	`getId()`
`int`	`getInitialPriority()` Returns the initial priority value for this page cache.
`String`	`getLanguageId()` Deprecated.
`Date`	`getNextGenerationDate()` Returns the date-time of the next generation of this page cache.
`int`	`getNumErrors()` Returns the number of consecutive generation errors for this page cache.
`String`	`getPageId()` Deprecated.
`String`	`getPageUrl()` Deprecated.
`int`	`getPriority()` Returns the current priority value for this page cache.
`int`	`getResourcePriority()` Returns the priority for generating the cache for the resource this cache is of.
`String`	`getServerId()` Returns the identifier of the server that last generated this page cache.
`int`	`getStatus()`
`WebResource`	`getWebResource()`
`void`	`setFilePath(String filePath)` Sets the path to the cache file, relative to the portal application web root.
`void`	`setInitialPriority(int initialPriority)` Sets the initial priority value for this page cache.
`void`	`setStatus(int status)`
`String`	`toString()`

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

- Field Detail
  - MIN_INITIAL_PRIORITY
```
public static final int MIN_INITIAL_PRIORITY
```
    Minimum priority value for getInitialPriority().
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - MAX_INITIAL_PRIORITY
```
public static final int MAX_INITIAL_PRIORITY
```
    Maximum priority value for getInitialPriority().
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_OUTDATED
```
public static final int STATUS_OUTDATED
```
    Status that indicates the cache is outdated.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_GENERATING
```
public static final int STATUS_GENERATING
```
    Status that indicates the cache being generated.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_GENERATING_OUTDATED
```
public static final int STATUS_GENERATING_OUTDATED
```
    Status that indicates the cache is being generated, but the generation result will be outdated, because something changed after the generation started.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_UPDATED
```
public static final int STATUS_UPDATED
```
    Status that indicates the cache is updated.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_OUTDATED_WITH_ERROR
```
public static final int STATUS_OUTDATED_WITH_ERROR
```
    Status that indicates the cache is outdated and has quit generating due to errors.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_DISABLED
```
public static final int STATUS_DISABLED
```
    Status that indicates the cache is disabled.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - STATUS_NOT_PUBLISHED
```
public static final int STATUS_NOT_PUBLISHED
```
    Status that indicates the target page is not published (its target content is not published).
    
    Since:
    
    10.2.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PageCacheConfig
```
public PageCacheConfig(WebResource webResource)
```
    Creates a PageCacheConfig for a web resource. The relationship on the this PageCacheConfig is set by this constructor, but not on the web resource side.
    
    Parameters:
    
    webResource - the web resource.
    
    Since:
    
    5.0.0
- Method Detail
  - getId
```
public String getId()
```
  - getWebResource
```
public WebResource getWebResource()
```
  - getPageUrl
```
@Deprecated
public String getPageUrl()
```
    Deprecated.
  - getLanguageId
```
@Deprecated
public String getLanguageId()
```
    Deprecated.
  - getPageId
```
@Deprecated
public String getPageId()
```
    Deprecated.
  - getStatus
```
public int getStatus()
```
  - setStatus
```
public void setStatus(int status)
```
  - getInitialPriority
```
public int getInitialPriority()
```
    Returns the initial priority value for this page cache.
    
    Returns:
    
    the initial priority value.
    
    Since:
    
    4.1.0
  - setInitialPriority
```
public void setInitialPriority(int initialPriority)
```
    Sets the initial priority value for this page cache.
    
    Parameters:
    
    initialPriority - the value to set.
    
    Since:
    
    4.1.0
  - getPriority
```
public int getPriority()
```
    Returns the current priority value for this page cache.
    
    Returns:
    
    the current priority value.
    
    Since:
    
    4.1.0
  - getResourcePriority
```
public int getResourcePriority()
```
    Returns the priority for generating the cache for the resource this cache is of. This is used to choose between caches with the same priority.
    
    Returns:
    
    the number of parameters.
    
    Since:
    
    5.0.0
  - getNumErrors
```
public int getNumErrors()
```
    Returns the number of consecutive generation errors for this page cache.
    
    Returns:
    
    the the number of consecutive generation errors for this page cache.
    
    Since:
    
    4.1.0
  - getFilePath
```
public String getFilePath()
```
    Returns the path to the cache file, relative to the portal application web root.
    
    Returns:
    
    the path, starting with '/'.
    
    Since:
    
    5.0.0
  - setFilePath
```
public void setFilePath(String filePath)
```
    Sets the path to the cache file, relative to the portal application web root.
    
    Parameters:
    
    filePath - the path, starting with '/'.
    
    Since:
    
    5.0.0
  - getServerId
```
public String getServerId()
```
    Returns the identifier of the server that last generated this page cache.
    
    Returns:
    
    the server identifier.
    
    Since:
    
    6.0.0
  - getNextGenerationDate
```
public Date getNextGenerationDate()
```
    Returns the date-time of the next generation of this page cache. If the value is null, the next generation doesn't have a fixed time to be started.
    
    Returns:
    
    the date-time of the next generation of this page cache.
    
    Since:
    
    6.2.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PageCacheConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_INITIAL_PRIORITY

MAX_INITIAL_PRIORITY

STATUS_OUTDATED

STATUS_GENERATING

STATUS_GENERATING_OUTDATED

STATUS_UPDATED

STATUS_OUTDATED_WITH_ERROR

STATUS_DISABLED

STATUS_NOT_PUBLISHED

Constructor Detail

PageCacheConfig

Method Detail

getId

getWebResource

getPageUrl

getLanguageId

getPageId

getStatus

setStatus

getInitialPriority

setInitialPriority

getPriority

getResourcePriority

getNumErrors

getFilePath

setFilePath

getServerId

getNextGenerationDate

toString