Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.cache
Interface IConfCacheQueryEngine

All Known Implementing Classes:
CompositeConfCacheQueryEngine, DefaultConfCacheQueryEngine

public interface IConfCacheQueryEngine

An interface defining a cache query engine contract.


Method Summary
 boolean canExecute(ICfgQuery query)
          Determines whether the query engine can execute the specified query.
<T extends ICfgObject>
java.util.Collection<T>
retrieveMultipleObjects(java.lang.Class<T> cls, ICfgQuery query)
          Retrieves a collection of objects based on the specified query.
<T extends ICfgObject>
T
retrieveObject(java.lang.Class<T> cls, CfgObjectType type, int dbid)
          Retrieves an object using the specified parameters.
<T extends ICfgObject>
T
retrieveObject(java.lang.Class<T> cls, ICfgQuery query)
          Retrieves an object based on the specified query.
 

Method Detail

canExecute

boolean canExecute(ICfgQuery query)
Determines whether the query engine can execute the specified query.

Parameters:
query - The query to execute
Returns:
true if the query engine can execute this query, false otherwise

retrieveObject

<T extends ICfgObject> T retrieveObject(java.lang.Class<T> cls,
                                        ICfgQuery query)
Retrieves an object based on the specified query.

Type Parameters:
T - The type of object to retrieve
Parameters:
cls - class of object to be retrieved
query - The query by which to retrieve the object
Returns:
The object specified by the query or null if the object is not found

retrieveMultipleObjects

<T extends ICfgObject> java.util.Collection<T> retrieveMultipleObjects(java.lang.Class<T> cls,
                                                                       ICfgQuery query)
Retrieves a collection of objects based on the specified query.

Type Parameters:
T - The type of object to retrieve
Parameters:
cls - class of objects to be retrieved
query - The query by which to retrieve the objects
Returns:
The objects specified by the query or an empty collection if no results are matching objects are found

retrieveObject

<T extends ICfgObject> T retrieveObject(java.lang.Class<T> cls,
                                        CfgObjectType type,
                                        int dbid)
Retrieves an object using the specified parameters.

Type Parameters:
T - The type of object to retrieve
Parameters:
cls - class of object to be retrieved
type - The type of object (CfgObjectType)
dbid - The dbid of the object
Returns:
A configuration object with the requested dbid and type or null if the object is not found

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.