Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com
Interface ICfgQuery<TT extends ICfgObject>

All Known Subinterfaces:
ICfgFilterBasedQuery<TT>
All Known Implementing Classes:
CfgAccessGroupQuery, CfgActionCodeQuery, CfgAgentGroupQuery, CfgAgentLoginQuery, CfgAlarmConditionQuery, CfgApplicationQuery, CfgAppPrototypeQuery, CfgCallingListQuery, CfgCampaignGroupQuery, CfgCampaignQuery, CfgDNGroupQuery, CfgDNQuery, CfgEnumeratorQuery, CfgEnumeratorValueQuery, CfgFieldQuery, CfgFilterBasedQuery, CfgFilterQuery, CfgFolderQuery, CfgFormatQuery, CfgGVPIVRProfileQuery, CfgHostQuery, CfgIVRPortQuery, CfgIVRQuery, CfgObjectiveTableQuery, CfgPersonQuery, CfgPhysicalSwitchQuery, CfgPlaceGroupQuery, CfgPlaceQuery, CfgQuery, CfgRoleQuery, CfgScheduledTaskQuery, CfgScriptQuery, CfgServiceQuery, CfgSkillQuery, CfgStatDayQuery, CfgStatTableQuery, CfgSwitchQuery, CfgTableAccessQuery, CfgTenantQuery, CfgTimeZoneQuery, CfgTransactionQuery, CfgTreatmentQuery, CfgVoicePromptQuery, CfgXPathBasedQuery

public interface ICfgQuery<TT extends ICfgObject>

The base interface for all queries.


Method Summary
<T extends ICfgObject>
AsyncRequestResult<T>
beginExecute(java.lang.Class<T> clazz, Action<AsyncRequestResult<T>> callback, java.lang.Object state)
          Deprecated. 
<T extends ICfgObject>
java.util.Collection<T>
endExecute(AsyncRequestResult<T> asyncResult)
          Deprecated. 
<T extends ICfgObject>
java.util.Collection<T>
execute(java.lang.Class<T> clazz)
          Deprecated. 
<T extends ICfgObject>
T
executeSingleResult(java.lang.Class<T> clazz)
          Deprecated. 
 

Method Detail

execute

@Deprecated
<T extends ICfgObject> java.util.Collection<T> execute(java.lang.Class<T> clazz)
                                                   throws ConfigException,
                                                          java.lang.InterruptedException
Deprecated. 

Executes the query and returns a list of objects read from the configuration server. It may return null if no objects read.

Type Parameters:
T - The type of configuration object returned
Parameters:
clazz - class used for generic matching
Returns:
A collection of configuration objects or null
Throws:
ConfigException
java.lang.InterruptedException

beginExecute

@Deprecated
<T extends ICfgObject> AsyncRequestResult<T> beginExecute(java.lang.Class<T> clazz,
                                                                     Action<AsyncRequestResult<T>> callback,
                                                                     java.lang.Object state)
                                                      throws ConfigException
Deprecated. 

Begins the asynchronous execution of the current query.

Parameters:
clazz - class used for generic matching
callback - The method to be called when query results are available
state - a user-defined object that qualifies or contains information about an asynchronous operation
Returns:
IAsyncResult describing the current operation
Throws:
ConfigException

endExecute

@Deprecated
<T extends ICfgObject> java.util.Collection<T> endExecute(AsyncRequestResult<T> asyncResult)
                                                      throws ConfigException,
                                                             java.lang.InterruptedException
Deprecated. 

Called to retrieve the result of asynchronous BeginExecute operation. Should be called on execution of AsyncCallback passed to BeginExecute. Will block calling thread until results are received if called before operation is completed.

Parameters:
asyncResult - The IAsyncResult object used to track the current request
Returns:
A list of retrieved objects or null
Throws:
ConfigException
java.lang.InterruptedException

executeSingleResult

@Deprecated
<T extends ICfgObject> T executeSingleResult(java.lang.Class<T> clazz)
                                         throws ConfigException
Deprecated. 

Executes a query the result of which is a single object of the specified type. Exception will be thrown if multiple objects are returned by the configuration server.

Type Parameters:
T - the type of object returned
Parameters:
clazz - class used for generic matching
Returns:
a configuration object or null
Throws:
ConfigException

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.