Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com
Class CfgFilterBasedQuery<TT extends ICfgObject>

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
      extended by com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery<TT>
All Implemented Interfaces:
ICfgFilterBasedQuery<TT>, ICfgQuery<TT>, ICfgQueryObjectClass<TT>
Direct Known Subclasses:
CfgAccessGroupQuery, CfgActionCodeQuery, CfgAgentGroupQuery, CfgAgentLoginQuery, CfgAlarmConditionQuery, CfgApplicationQuery, CfgAppPrototypeQuery, CfgCallingListQuery, CfgCampaignGroupQuery, CfgCampaignQuery, CfgDNGroupQuery, CfgDNQuery, CfgEnumeratorQuery, CfgEnumeratorValueQuery, CfgFieldQuery, CfgFilterQuery, CfgFolderQuery, CfgFormatQuery, CfgGVPIVRProfileQuery, CfgHostQuery, CfgIVRPortQuery, CfgIVRQuery, CfgObjectiveTableQuery, CfgPersonQuery, CfgPhysicalSwitchQuery, CfgPlaceGroupQuery, CfgPlaceQuery, CfgRoleQuery, CfgScheduledTaskQuery, CfgScriptQuery, CfgServiceQuery, CfgSkillQuery, CfgStatDayQuery, CfgStatTableQuery, CfgSwitchQuery, CfgTableAccessQuery, CfgTenantQuery, CfgTimeZoneQuery, CfgTransactionQuery, CfgTreatmentQuery, CfgVoicePromptQuery

public class CfgFilterBasedQuery<TT extends ICfgObject>
extends CfgQuery<TT>
implements ICfgFilterBasedQuery<TT>, ICfgQueryObjectClass<TT>

A general class that can hold arbitrary values of filter keys and values.
It contains a collection of filter key-value pairs. If you have a need to work with multiple queries for objects, type of which is not known in compile-time, use this class.
If you know the type of the objects, please, use more specific Cfg***Query classes.

Author:
Petr Makagon, Vladislav Baranovsky, Alexander Filatov, Anton Brazhnyk, Sergii Volokh

Constructor Summary
CfgFilterBasedQuery(CfgObjectType objType)
          Creates a new instance of the class.
CfgFilterBasedQuery(CfgObjectType objectType, IConfService confService)
          Deprecated.  
 
Method Summary
 boolean equals(java.lang.Object obj)
           
<T extends ICfgObject>
java.lang.Class<T>
getCfgObjectClass()
          Deprecated. 
 CfgObjectType getCfgObjectType()
          The Configuration Server object type that the query corresponds to.
 boolean getDoRequestFolderId()
          Gets filter option for notification of configuration server about need of the folder DBID information to be sent with the main objects data.
 boolean getDoRequestObjectPath()
          Gets filter option for notification of configuration server about need of the object path information to be collected and sent with the main objects data.
 java.util.Hashtable<java.lang.String,java.lang.Object> getExtraFilter()
          Returns additional request filter properties for server object(s) read request.
 java.util.Hashtable<java.lang.String,java.lang.Object> getFilter()
          Returns map with filter properties set.
 int getInt(java.lang.String name)
          Retrieves the value of the filter key-value pair as integer value.
 java.lang.Object getProperty(java.lang.String name)
          Retrieves the value of the filter key-value pair.
 java.lang.Class<TT> getQueryObjectClass()
           
 java.lang.String getString(java.lang.String name)
          Retrieves the value of the filter key-value pair as string value.
 int hashCode()
           
 void setDoRequestFolderId(boolean value)
          Sets filter option for notification of configuration server about need of the folder DBID information to be sent with the main objects data.
 void setDoRequestObjectPath(boolean value)
          Sets filter option for notification of configuration server about need of the object path information to be collected and sent with the main objects data.
protected  void setObjectClass(java.lang.Class<TT> clazz)
           
 void setProperty(java.lang.String name, java.lang.Object newValue)
          Set the new value of the filter key-value pair.
 java.lang.String toString()
           
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgQuery
beginExecute, endExecute, execute, execute, executeSingleResult, executeSingleResult
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgQuery
beginExecute, endExecute, execute, executeSingleResult
 

Constructor Detail

CfgFilterBasedQuery

@Deprecated
public CfgFilterBasedQuery(CfgObjectType objectType,
                                      IConfService confService)
Deprecated. 

Creates a new instance of the class.

Parameters:
objectType - type of object returned by this query.
confService - reference to IConfService to be used for query execution.

CfgFilterBasedQuery

public CfgFilterBasedQuery(CfgObjectType objType)
Creates a new instance of the class.

Parameters:
objType - configuration server object type to read.
Method Detail

setObjectClass

protected void setObjectClass(java.lang.Class<TT> clazz)

setDoRequestObjectPath

public void setDoRequestObjectPath(boolean value)
Description copied from interface: ICfgFilterBasedQuery
Sets filter option for notification of configuration server about need of the object path information to be collected and sent with the main objects data.

If this option value is true, ConfService will add filter parameter "object_path" to the read request.
After the configuration object(s) are read, the resulting object path value(s) will be accessible as CfgObject.getObjectPath().

It is enabled by default.

Specified by:
setDoRequestObjectPath in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Parameters:
value - the object path request enabling flag value.
See Also:
CfgObject.getObjectPath()

getDoRequestObjectPath

public boolean getDoRequestObjectPath()
Description copied from interface: ICfgFilterBasedQuery
Gets filter option for notification of configuration server about need of the object path information to be collected and sent with the main objects data.

If this option value is true, ConfService will add filter parameter "object_path" to the read request.
After the configuration object(s) are read, the resulting object path value(s) will be accessible as CfgObject.getObjectPath().

Specified by:
getDoRequestObjectPath in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Returns:
the object path request enabling flag value.
See Also:
CfgObject.getObjectPath()

setDoRequestFolderId

public void setDoRequestFolderId(boolean value)
Description copied from interface: ICfgFilterBasedQuery
Sets filter option for notification of configuration server about need of the folder DBID information to be sent with the main objects data.

If this option value is true, ConfService will add filter parameter "read_folder_dbid" to the read request.
After the configuration object(s) are read, the resulting folder DBID value(s) will be accessible as CfgObject.getFolderId().

It is enabled by default.

Specified by:
setDoRequestFolderId in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Parameters:
value - the folder DBID request enabling flag value.
See Also:
CfgObject.getFolderId()

getDoRequestFolderId

public boolean getDoRequestFolderId()
Description copied from interface: ICfgFilterBasedQuery
Gets filter option for notification of configuration server about need of the folder DBID information to be sent with the main objects data.

If this option value is true, ConfService will add filter parameter "read_folder_dbid" to the read request.
After the configuration object(s) are read, the resulting folder DBID value(s) will be accessible as CfgObject.getFolderId().

Specified by:
getDoRequestFolderId in interface ICfgFilterBasedQuery<TT extends ICfgObject>
See Also:
CfgObject.getFolderId()

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object newValue)
Set the new value of the filter key-value pair.

Specified by:
setProperty in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Parameters:
name - Filter key
newValue - New filter value

getProperty

public java.lang.Object getProperty(java.lang.String name)
Retrieves the value of the filter key-value pair.

Specified by:
getProperty in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Parameters:
name - Filter key
Returns:
filter value

getInt

public int getInt(java.lang.String name)
Description copied from interface: ICfgFilterBasedQuery
Retrieves the value of the filter key-value pair as integer value.

Specified by:
getInt in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Parameters:
name - Filter key
Returns:
filter value

getString

public java.lang.String getString(java.lang.String name)
Description copied from interface: ICfgFilterBasedQuery
Retrieves the value of the filter key-value pair as string value.

Specified by:
getString in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Parameters:
name - Filter key
Returns:
filter value

getCfgObjectType

public CfgObjectType getCfgObjectType()
Description copied from interface: ICfgFilterBasedQuery
The Configuration Server object type that the query corresponds to.

Specified by:
getCfgObjectType in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Returns:
object type

getCfgObjectClass

@Deprecated
public <T extends ICfgObject> java.lang.Class<T> getCfgObjectClass()
Deprecated. 


getQueryObjectClass

public java.lang.Class<TT> getQueryObjectClass()
Specified by:
getQueryObjectClass in interface ICfgQueryObjectClass<TT extends ICfgObject>

getFilter

public java.util.Hashtable<java.lang.String,java.lang.Object> getFilter()
Description copied from interface: ICfgFilterBasedQuery
Returns map with filter properties set.

Specified by:
getFilter in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Returns:
filter map.
See Also:
ICfgFilterBasedQuery.getExtraFilter()

getExtraFilter

public java.util.Hashtable<java.lang.String,java.lang.Object> getExtraFilter()
Description copied from interface: ICfgFilterBasedQuery
Returns additional request filter properties for server object(s) read request.

Specified by:
getExtraFilter in interface ICfgFilterBasedQuery<TT extends ICfgObject>
Returns:
extra filter map.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

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.