com.opencms.template.cache
Class CmsTimeout

java.lang.Object
  |
  +--com.opencms.template.cache.CmsTimeout

public class CmsTimeout
extends Object

This class is used in the CmsCacheDirectives. If an element can be cached for a specific time, a CmsTimeout must be set. It is planned to have diffrent modi for this Class. In this moment we have only one mode: 0: use the constructor with int x. It means the element has to be new generated at 00:00 and then every x minutes.

Version:
1.0
Author:
Hanjo Riege

Constructor Summary
CmsTimeout(int minutes)
           
 
Method Summary
 long getLastChange()
          Returns the last time when the element had to be new generated.
 boolean isProxyCacheable()
          The proxy cache is set for 300 seconds.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsTimeout

public CmsTimeout(int minutes)
Method Detail

isProxyCacheable

public boolean isProxyCacheable()
The proxy cache is set for 300 seconds. If this Timeout shows problems with this interval the method returns false. In modus 0 <=> timeintervals < 300.

Returns:
false if the element is not proxycacheable.

getLastChange

public long getLastChange()
Returns the last time when the element had to be new generated.

Returns:
last change time.