Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com
Interface IConfServicePolicy

All Known Implementing Classes:
CachingConfServicePolicy

public interface IConfServicePolicy

The interface to be implemented when defining a policy for the configuration service. The cache-related properties are only valid when caching is enabled.


Method Summary
 boolean getAttemptLinkResolutionThroughCache(CfgObjectType objectType)
          Determines whether link resolution should be attempted through the cache before querying the configuration server (link resolution refers to the automatic retrieval of configuration objects when certain properties are accessed).
 boolean getCacheOnRetrieve(ICfgObject obj)
          Determines whether the specified object should be cached upon being retrieved from the configuration server.
 boolean getCacheOnSave(ICfgObject obj)
          Determines whether the specified object should be cached upon being saved in the configuration server.
 boolean getOverwriteCachedVersionOnRetrieve(ICfgObject newObj)
          Determines whether an existing cached object should be overwritten if a newer copy is retrieved from configuration server.
 boolean getQueryCacheOnRetrieve(ICfgQuery query)
          Determines whether the cache should be queried before a retrieve operation is performed.
 boolean getQueryCacheOnRetrieveMultiple(ICfgQuery query)
          Determines whether the cache should be queried before a retrieve multiple operation is performed.
 boolean getValidateBeforeSave()
          Determines whether the properties of an object should be validated for correctness before a save operation is attempted.
 void setValidateBeforeSave(boolean value)
          Determines whether the properties of an object should be validated for correctness before a save operation is attempted.
 

Method Detail

getQueryCacheOnRetrieve

boolean getQueryCacheOnRetrieve(ICfgQuery query)
Determines whether the cache should be queried before a retrieve operation is performed.

Parameters:
query - The query for the retrieve operation
Returns:
true if the cache should be queried first, false otherwise

getQueryCacheOnRetrieveMultiple

boolean getQueryCacheOnRetrieveMultiple(ICfgQuery query)
Determines whether the cache should be queried before a retrieve multiple operation is performed.

Parameters:
query - The query for the retrieve operation
Returns:
true if the cache should be queried first, false otherwise

getCacheOnRetrieve

boolean getCacheOnRetrieve(ICfgObject obj)
Determines whether the specified object should be cached upon being retrieved from the configuration server.

Parameters:
obj - The retrieved configuration object
Returns:
true if the object should be cached, false otherwise

getCacheOnSave

boolean getCacheOnSave(ICfgObject obj)
Determines whether the specified object should be cached upon being saved in the configuration server.

Parameters:
obj - The configuration object being saved
Returns:
true if the object should be cached, false otherwise

getAttemptLinkResolutionThroughCache

boolean getAttemptLinkResolutionThroughCache(CfgObjectType objectType)
Determines whether link resolution should be attempted through the cache before querying the configuration server (link resolution refers to the automatic retrieval of configuration objects when certain properties are accessed).

Parameters:
objectType - The type of object for which link resolution is to be attempted
Returns:
true if link resolution should be attempted through the cache, false if configuration server should be queried

getOverwriteCachedVersionOnRetrieve

boolean getOverwriteCachedVersionOnRetrieve(ICfgObject newObj)
Determines whether an existing cached object should be overwritten if a newer copy is retrieved from configuration server.

Parameters:
newObj - the new version of a cached object
Returns:
true if the object should be overwritten in the cache, false otherwise

getValidateBeforeSave

boolean getValidateBeforeSave()
Determines whether the properties of an object should be validated for correctness before a save operation is attempted.

Returns:
true if objects should be validated before save

setValidateBeforeSave

void setValidateBeforeSave(boolean value)
Determines whether the properties of an object should be validated for correctness before a save operation is attempted.

Parameters:
value - new value for the validation enabling property

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.