com.sapportals.wcm.control.util

Interface IPersistenceProvider

All Known Implementing Classes:

ResourceTreeControl

Deprecated.

As of NetWeaver 7.1

public interface IPersistenceProvider

Method Summary

Modifier and Type	Method and Description
boolean	addObjectToCache(Object key, Object value, boolean overwrite) Deprecated. As of NetWeaver 7.1
Set	getKeySet() Deprecated. As of NetWeaver 7.1
Object	getObjectFromCache(Object key) Deprecated. As of NetWeaver 7.1
boolean	removeObjectFromCache(Object key) Deprecated. As of NetWeaver 7.1

Method Detail

getObjectFromCache

Object getObjectFromCache(Object key)

Deprecated. As of NetWeaver 7.1

Elements within the flexible rendering, e.g. IResourceRenderer that cannot use the WDF persistence service, can use this method and addObjectToCache to store elements in the cache and to persist them through the http-request cycle. Please note, that it's the calling object's responsibility to ensure the uniqueness of its keys.

Parameters:

key - the key to the object in the Cache

Returns:

the object that belongs to this key or null, if this key is not known in the cache.

addObjectToCache

boolean addObjectToCache(Object key,
                         Object value,
                         boolean overwrite)

Deprecated. As of NetWeaver 7.1

Parameters:

key - the key to store and retrieve the stored object with

value - the value to store

overwrite - flag, to decide, if an existing key-value pair should be replaced with the given set. Please see getObjectFromCache for further information about this method

Returns:

false, if the entry already exists and the parameter overwrite was set to false

removeObjectFromCache

boolean removeObjectFromCache(Object key)

Deprecated. As of NetWeaver 7.1

When a user of this service does not need the entry any longer, it should remove it. The underlying cache-implementations (e.g. the transient cache of the IUser may not implement an automatic expiration of unused entries.

Returns:

true, if an entry was found and removed

getKeySet

Set getKeySet()

Deprecated. As of NetWeaver 7.1

Returns:

a Set with all keys or an empty Set, never null

Since:

EP6, SP1. returns all keys that are currently stored within this provider.