com.ibm.portal.wcm.plr
Interface CacheSpec

All Known Subinterfaces:

DependencyCacheSpec

public interface CacheSpec

This interface describes how a given BeanList provided by a BeanListResponse object can be cached.

Since:

8.5.0.0

Note:

This interface is designed to be implemented by clients.

Nested Class Summary

static class

CacheSpec.Type Indicates the type of cache that shall be used to cache the given BeanList object.

Method Summary

java.lang.Object	getCacheKey() Returns the cache key for a given object.
CacheSpec.Type	getType() Returns the cache type for caching a given BeanList.

Method Detail

getCacheKey

java.lang.Object getCacheKey()

Returns the cache key for a given object. Implementations of this method need to make sure that all information affecting the contents of the given object is reflected in the returned cache key. An object may return null. In this case, the object will not be cached. Cached objects may be access by concurrent threads and requests.

Returns:

the cache key for a given object

getType

CacheSpec.Type getType()

Returns the cache type for caching a given BeanList. The returned value can be one of:

• Type.DEFAULT
• Type.INVALIDATE_ON_LOGIN

Returns:

the cache type