com.ibm.commerce.cache.commands
Interface CacheCommand

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
CacheCommandImpl

public interface CacheCommand
extends TaskCommand

CacheCommand is called to retrieve custom dynamic page index parameters Implementations of the CacheCommand interface can be used to provide additional information for the indexing of WCBE dynamic cache pages. The CacheCommand implementation class is called during the invocation of every command whose sessionDependent attribute is set to "true" in the Cache section of the WCBE configuration file.


Field Summary
static java.lang.String NAME
           
 
Fields inherited from interface com.ibm.commerce.command.TaskCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 java.util.Vector getKeyValues()
          Each element returned in the return Vector will have its toString() method called and the results will be added to the cache index during cache file naming.
 void setKeyValues(java.util.Vector avKeyValues)
          Returns a vector of values to be added to the cache page index string.
 void setRequestProperties(TypedProperty param)
          Sets the name of the default document to be returned by this view command
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

NAME

public static final java.lang.String NAME
Method Detail

getKeyValues

public java.util.Vector getKeyValues()
Each element returned in the return Vector will have its toString() method called and the results will be added to the cache index during cache file naming.
Returns:
java.util.Vector

setKeyValues

public void setKeyValues(java.util.Vector avKeyValues)
Returns a vector of values to be added to the cache page index string. toString() is called for every element in the Vector during cache page naming.
Parameters:
avKeyValues - java.lang.Vector

setRequestProperties

public void setRequestProperties(TypedProperty param)
                          throws ECApplicationException
Sets the name of the default document to be returned by this view command
Parameters:
name - java.lang.String