Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.cache
Interface IConfCacheStorage

All Known Implementing Classes:
DefaultConfCacheStorage

public interface IConfCacheStorage

An interface which defines the contract for a configuration cache storage module.


Method Summary
 void add(ICfgObject obj)
          Adds the configuration object to the storage.
 void clear()
          Removes all items in storage.
 boolean remove(ICfgObject obj)
          Removes the specified configuration object from the storage.
<T extends ICfgObject>
java.lang.Iterable<T>
retrieve(java.lang.Class<T> cls)
          Retrieves a list of all objects in the storage.
<T extends ICfgObject>
java.lang.Iterable<T>
retrieve(java.lang.Class<T> cls, java.lang.Object helper)
          Retrieves a list of objects in storage utilizing a "helper" parameter.
 void update(ICfgObject obj)
          Updates an existing configuration object in the storage with the passed copy.
 

Method Detail

add

void add(ICfgObject obj)
Adds the configuration object to the storage.

Parameters:
obj - The configuration object

update

void update(ICfgObject obj)
Updates an existing configuration object in the storage with the passed copy.

Parameters:
obj - The new version of a cached configuration object

remove

boolean remove(ICfgObject obj)
Removes the specified configuration object from the storage.

Parameters:
obj - The configuration object to remove
Returns:
true if object successfully deleted, false otherwise

clear

void clear()
Removes all items in storage.


retrieve

<T extends ICfgObject> java.lang.Iterable<T> retrieve(java.lang.Class<T> cls)
Retrieves a list of all objects in the storage.

Type Parameters:
T - The type of object in the resulting list
Parameters:
cls - class of objects to be retrieved
Returns:
An enumerable list of the requested objects

retrieve

<T extends ICfgObject> java.lang.Iterable<T> retrieve(java.lang.Class<T> cls,
                                                      java.lang.Object helper)
Retrieves a list of objects in storage utilizing a "helper" parameter.

Type Parameters:
T - The type of object in the resulting list
Parameters:
cls - class of objects to be retrieved
helper - A helper parameter to be defined in each implementation
Returns:
An enumerable list of the requested objects

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.