com.ibm.commerce.registry

Interface ElementUpdate

All Known Implementing Classes:

AbstractManagedDynamicCacheRegistry, ExperimentRegistry, StoreRegistry, TradingAgreementRegistry

public interface ElementUpdate

This is an interface for extending a Registry to support update to individual element in the registry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createKey(java.lang.String strKey) Creates a cache key from the string representation of the key.
java.lang.String	createKeyString(TypedProperty prop) Creates a string representation of a cache key based on the input properties.
java.lang.Object	getElement(java.lang.Object key) Gets the element to be refreshed from the cache.
void	update(java.lang.String action, java.lang.Object key) Updates an element in the registry.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

update

void update(java.lang.String action,
            java.lang.Object key)
     throws java.lang.Exception

Updates an element in the registry.

Parameters:

action - The action to be applied to the cached element

key - The cache key

Throws:

java.lang.Exception

createKeyString

java.lang.String createKeyString(TypedProperty prop)
                          throws java.lang.Exception

Creates a string representation of a cache key based on the input properties.

Parameters:

prop - The input properties

Returns:

The string representation of a cache key

Throws:

java.lang.Exception

createKey

java.lang.Object createKey(java.lang.String strKey)
                    throws java.lang.Exception

Creates a cache key from the string representation of the key.

Parameters:

keyStr - The string representation of a cache key

Returns:

a cache key

Throws:

java.lang.Exception

getElement

java.lang.Object getElement(java.lang.Object key)

Gets the element to be refreshed from the cache.

Parameters:

key - The cache key for the element

Returns:

the cached element associated with the key