com.sapportals.portal.navigation

Interface INavigationCacheManager

Deprecated. Replaced by { @link com.sap.portal.cache }

public interface INavigationCacheManager

Field Summary

static String

KEY Deprecated. The key for retrieving an instance of this service.

Method Summary

String[]	applyCacheAction(String cacheID, CacheAction cacheAction, boolean cluster) Deprecated. Applies a cache action for the specified cache IDs, locally or cluster wide.
String[]	applyCacheAction(String cacheID, CacheAction cacheAction, String[] entryIDs, boolean recursive, boolean cluster) Deprecated. Applies a cache action to specific cache entries for a specified cache ID, locally or cluster wide.
String[]	getAllCacheIDs() Deprecated. Retrieves an array of all navigation cache IDs
CacheConfigurator	getCacheConfigurator(String cacheID) Deprecated. Return a configurator for a specified cache ID
boolean	setCacheConfigurator(CacheConfigurator configurator) Deprecated. Sets a connector configuration according to cache configurator
String[]	setCacheEnable(boolean enable) Deprecated. Enables/Disables all navigation caches

Field Detail

KEY

static final String KEY

Deprecated.

The key for retrieving an instance of this service.

See Also:

Constant Field Values

Method Detail

getCacheConfigurator

CacheConfigurator getCacheConfigurator(String cacheID)

Deprecated.

Return a configurator for a specified cache ID

Parameters:

cacheID - - The cacheID for which to get the configurator

Returns:

A cache configurator for the cache

setCacheConfigurator

boolean setCacheConfigurator(CacheConfigurator configurator)

Deprecated.

Sets a connector configuration according to cache configurator

Parameters:

configurator - - The configurator according to which configure the cache

Returns:

true if all configurations succeeded

getAllCacheIDs

String[] getAllCacheIDs()

Deprecated.

Retrieves an array of all navigation cache IDs

Returns:

The IDs of all navigation caches

setCacheEnable

String[] setCacheEnable(boolean enable)

Deprecated.

Enables/Disables all navigation caches

Parameters:

enable - - if true enables all caches

Returns:

String[]

applyCacheAction

String[] applyCacheAction(String cacheID,
                          CacheAction cacheAction,
                          boolean cluster)

Deprecated.

Applies a cache action for the specified cache IDs, locally or cluster wide.

Parameters:

cacheID - navigation cache ID for which you want to apply the action

cacheAction - an int representing the cache action. Available cache actions are in class CacheAction

cluster - Defines whether to apply action on cache locally or cluster wide. If true then applies action cluster wide.

Returns:

A list of cache IDs which failed to apply action

applyCacheAction

String[] applyCacheAction(String cacheID,
                          CacheAction cacheAction,
                          String[] entryIDs,
                          boolean recursive,
                          boolean cluster)

Deprecated.

Applies a cache action to specific cache entries for a specified cache ID, locally or cluster wide.

Parameters:

cacheID - Cache ID for which to apply the cache action.

cacheAction - An int representing the cache action. Available cache actions are in class CacheAction

entryIDs - Entry IDs to apply the action on.

recursive - Defines whether to apply action recursively. If true applies recursivly

cluster - Defines whether to apply action on cache entries locally or cluster wide. If true then apply action cluster wide

Returns:

A list of cache IDs which failed to apply action

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN