Skip navigation links

com.stellent.cis.client.api.common.administrative.cache.scs
Interface ISCSCachePolicy

All Superinterfaces:

ICISObject, ICISObjectInitializable, java.io.Serializable

All Known Subinterfaces:

ISCSFileCachePolicy, ISCSServiceCachePolicy

public interface ISCSCachePolicy

extends ICISObject, ICISObjectInitializable

A caching policy for an Active API

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

static int	CACHE_TYPE_GLOBAL
static int	CACHE_TYPE_USER

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

long	getCacheTimeout()
int	getCacheType() Get the cache type
java.lang.String	getServiceName()
boolean	isCacheEnabled() Determines if this command has caching enabled
boolean	isDefault()
void	setCacheEnabled(boolean enabled) Set the cache flag for this command
void	setCacheTimeout(long timeout)
void	setCacheType(int cacheType) Set the cache type for this command
void	setDefault(boolean isDefault)
void	setServiceName(java.lang.String service) Set the service name

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Field Detail

CACHE_TYPE_GLOBAL

static final int CACHE_TYPE_GLOBAL

See Also:

Constant Field Values

CACHE_TYPE_USER

static final int CACHE_TYPE_USER

See Also:

Constant Field Values

Method Detail

getServiceName

java.lang.String getServiceName()

Returns:

the name of the service this cache policy represents

setServiceName

void setServiceName(java.lang.String service)

Set the service name

Parameters:

service - the name of the service

setCacheType

void setCacheType(int cacheType)

Set the cache type for this command

Parameters:

cacheType - the type of cache, can be either CACHE_TYPE_GLOBAL or CACHE_TYPE_USER

getCacheType

int getCacheType()

Get the cache type

Returns:

the type of cache

isCacheEnabled

boolean isCacheEnabled()

Determines if this command has caching enabled

Returns:

true if cache is enabled, false otherwise

setCacheEnabled

void setCacheEnabled(boolean enabled)

Set the cache flag for this command

Parameters:

enabled - true to enable the cache, false to disable

getCacheTimeout

long getCacheTimeout()

Returns:

the cache timeout value for this entry

setCacheTimeout

void setCacheTimeout(long timeout)

Parameters:

timeout - the amount of time this entry is valid in the cache

isDefault

boolean isDefault()

Returns:

true if this is the default policy

setDefault

void setDefault(boolean isDefault)

Parameters:

isDefault - set to true if it is the default

Skip navigation links