org.apache.jetspeed.om.registry
Interface CachedParameter

All Superinterfaces:

Parameter, RegistryEntry

All Known Implementing Classes:

BaseCachedParameter

public interface CachedParameter

extends Parameter

Interface describing a cached parameter for a registry entry.

Version:

$Id: CachedParameter.java,v 1.2 2004/02/23 03:11:39 jford Exp $

Author:

David Sean Taylor

Method Summary

boolean	isCachedOnName() Determines whether to use the parameter name as part of the unique id to the portlet cache.
boolean	isCachedOnValue() Determines whether to use the parameter value as part of the unique id to the portlet cache.
void	setCachedOnName(boolean cache) Determines whether to use the parameter name as part of the unique id to the portlet cache.
void	setCachedOnValue(boolean cache) Determines whether to use the parameter value as part of the unique id to the portlet cache.

Methods inherited from interface org.apache.jetspeed.om.registry.Parameter

getParameterStyle, getType, getValue, setParameterStyle, setType, setValue

Methods inherited from interface org.apache.jetspeed.om.registry.RegistryEntry

getDescription, getId, getMetaInfo, getName, getSecurity, getSecurityRef, getTitle, isHidden, setDescription, setHidden, setMetaInfo, setName, setSecurity, setSecurityRef, setTitle

Method Detail

isCachedOnName

public boolean isCachedOnName()

Determines whether to use the parameter name as part of the unique id to the portlet cache. This can be used to control the lifetime of the portlet. The name is used in combination with the URL and parameter values for this portlet to uniquely identify to portlet. This value can be set in the portlet registry.

Returns:

cached set to true if want this portlet to be cached based on the parameter name

isCachedOnValue

public boolean isCachedOnValue()

Determines whether to use the parameter value as part of the unique id to the portlet cache. This can be used to control the lifetime of the portlet. The value is used in combination with the URL and parameter names for this portlet to uniquely identify to portlet. This value can be set in the portlet registry.

Returns:

cached set to true if want this portlet to be cached based on the parameter value

setCachedOnName

public void setCachedOnName(boolean cache)

Determines whether to use the parameter name as part of the unique id to the portlet cache. This can be used to control the lifetime of the portlet. The name is used in combination with the URL and parameter values for this portlet to uniquely identify to portlet. This value can be set in the portlet registry.

Returns:

cached Set to true if want this portlet to be cached based on the parameter name

setCachedOnValue

public void setCachedOnValue(boolean cache)

Determines whether to use the parameter value as part of the unique id to the portlet cache. This can be used to control the lifetime of the portlet. The value is used in combination with the URL and parameter names for this portlet to uniquely identify to portlet. This value can be set in the portlet registry.

Returns:

cached Set to true if want this portlet to be cached based on the parameter value