com.sap.portal.cache.api

Class CacheAction

java.lang.Object

com.sap.portal.cache.api.CacheAction

Direct Known Subclasses:

ChangeConfigAction, ClearAction, EnableAction, SyncAction

public class CacheAction
extends Object

Represents a generic cache action that can be performed on a cache. Each cache implementation can define a number of such actions. Receives the following parameters: the ID of the cache, the ID of the specific cache action implementation, and a map of parameters that are required for performing the action, if applicable.

See Also:

ICacheManager, ApplyActionException

Constructor Summary

Constructors

Constructor and Description
CacheAction()
CacheAction(String cacheID, String actionID, HashMap actionParams) Creates a cache Action object

Method Summary

Modifier and Type	Method and Description
String	getActionID() Returns the ID of this action
HashMap	getActionParams() Returs a map of parameters required for applying this action
String	getCacheID() Returns the cache ID of this action
void	setActionParams(HashMap actionParams) Sets the parameters required for this action
String	toString() Returns a string representation of this action

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheAction

public CacheAction()

CacheAction

public CacheAction(String cacheID,
                   String actionID,
                   HashMap actionParams)

Creates a cache Action object

Parameters:

cacheID - ID of the cache that enables the current action

actionID - The ID of the action as taken from the specific cache available actions

actionParams - Map of the parameters and values required for this action

Method Detail

getActionID

public String getActionID()

Returns the ID of this action

Returns:

actionID

getCacheID

public String getCacheID()

Returns the cache ID of this action

Returns:

cacheID

setActionParams

public void setActionParams(HashMap actionParams)

Sets the parameters required for this action

Parameters:

actionParams - a map of parameter key, value.

getActionParams

public HashMap getActionParams()

Returs a map of parameters required for applying this action

Returns:

an HashMap of the action parameters

toString

public String toString()

Returns a string representation of this action

Overrides:

toString in class Object