org.apache.jetspeed.om.registry.base
Class BaseCachedParameter

java.lang.Object
  org.apache.jetspeed.om.registry.base.BaseRegistryEntry
      org.apache.jetspeed.om.registry.base.BaseParameter
          org.apache.jetspeed.om.registry.base.BaseCachedParameter

All Implemented Interfaces:

CachedParameter, Parameter, RegistryEntry, java.io.Serializable

public class BaseCachedParameter

extends BaseParameter

implements CachedParameter, java.io.Serializable

Bean like implementation of the Parameter interface suitable for Castor serialization.

Version:

$Id: BaseCachedParameter.java,v 1.6 2004/07/21 06:07:45 taylor Exp $

Author:

David Sean Taylor

See Also:

Parameter, Serialized Form

Field Summary

Fields inherited from class org.apache.jetspeed.om.registry.base.BaseRegistryEntry

_hidden, hidden, metaInfo, name, security, securityRef

Constructor Summary

BaseCachedParameter()

BaseCachedParameter(long id)

Method Summary

boolean	equals(java.lang.Object object) Implements the equals operation so that 2 elements are equal if all their member values are equal.
boolean	getCachedOnName()
boolean	getCachedOnValue()
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 cached) Determines whether to use the parameter name as part of the unique id to the portlet cache.
void	setCachedOnValue(boolean cached) Determines whether to use the parameter value as part of the unique id to the portlet cache.

Methods inherited from class org.apache.jetspeed.om.registry.base.BaseParameter

getBaseParameterStyle, getParameterStyle, getType, getValue, setBaseParameterStyle, setParameterStyle, setType, setValue

Methods inherited from class org.apache.jetspeed.om.registry.base.BaseRegistryEntry

getBaseMetaInfo, getBaseSecurity, getDescription, getHidden, getId, getMetaInfo, getName, getSecurity, getSecurityRef, getTitle, isHidden, setBaseMetaInfo, setBaseSecurity, setDescription, setHidden, setMetaInfo, setName, setSecurity, setSecurityRef, setTitle

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

BaseCachedParameter

public BaseCachedParameter()

BaseCachedParameter

public BaseCachedParameter(long id)

Method Detail

equals

public boolean equals(java.lang.Object object)

Implements the equals operation so that 2 elements are equal if all their member values are equal.

Overrides:

equals in class BaseParameter

isCachedOnName

public boolean isCachedOnName()

Description copied from interface: CachedParameter

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.

Specified by:

isCachedOnName in interface CachedParameter

Returns:

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

isCachedOnValue

public boolean isCachedOnValue()

Description copied from interface: CachedParameter

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.

Specified by:

isCachedOnValue in interface CachedParameter

Returns:

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

setCachedOnName

public void setCachedOnName(boolean cached)

Description copied from interface: CachedParameter

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.

Specified by:

setCachedOnName in interface CachedParameter

Returns:

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

setCachedOnValue

public void setCachedOnValue(boolean cached)

Description copied from interface: CachedParameter

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.

Specified by:

setCachedOnValue in interface CachedParameter

Returns:

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

getCachedOnName

public boolean getCachedOnName()

getCachedOnValue

public boolean getCachedOnValue()