Platform SDK Java 8.5 API Reference

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

All Superinterfaces:
ICfgQuery<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, CfgRoleQuery, CfgScheduledTaskQuery, CfgScriptQuery, CfgServiceQuery, CfgSkillQuery, CfgStatDayQuery, CfgStatTableQuery, CfgSwitchQuery, CfgTableAccessQuery, CfgTenantQuery, CfgTimeZoneQuery, CfgTransactionQuery, CfgTreatmentQuery, CfgVoicePromptQuery

public interface ICfgFilterBasedQuery<TT extends ICfgObject>
extends ICfgQuery<TT>

Each filter-based query object should implement this general interface.


Method Summary
 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.String getString(java.lang.String name)
          Retrieves the value of the filter key-value pair as string value.
 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.
 void setProperty(java.lang.String name, java.lang.Object newValue)
          Set the new value of the filter key-value pair.
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgQuery
beginExecute, endExecute, execute, executeSingleResult
 

Method Detail

setProperty

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

Parameters:
name - Filter key
newValue - New filter value

getProperty

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

Parameters:
name - Filter key
Returns:
filter value

getInt

int getInt(java.lang.String name)
Retrieves the value of the filter key-value pair as integer value.

Parameters:
name - Filter key
Returns:
filter value

getString

java.lang.String getString(java.lang.String name)
Retrieves the value of the filter key-value pair as string value.

Parameters:
name - Filter key
Returns:
filter value

getCfgObjectType

CfgObjectType getCfgObjectType()
The Configuration Server object type that the query corresponds to.

Returns:
object type

getFilter

java.util.Hashtable<java.lang.String,java.lang.Object> getFilter()
Returns map with filter properties set.

Returns:
filter map.
See Also:
getExtraFilter()

getExtraFilter

java.util.Hashtable<java.lang.String,java.lang.Object> getExtraFilter()
Returns additional request filter properties for server object(s) read request.

Returns:
extra filter map.

setDoRequestObjectPath

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.

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.

Parameters:
value - the object path request enabling flag value.
See Also:
CfgObject.getObjectPath()

getDoRequestObjectPath

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.

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().

Returns:
the object path request enabling flag value.
See Also:
CfgObject.getObjectPath()

setDoRequestFolderId

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.

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.

Parameters:
value - the folder DBID request enabling flag value.
See Also:
CfgObject.getFolderId()

getDoRequestFolderId

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.

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().

Parameters:
value - the folder DBID request enabling flag value.
See Also:
CfgObject.getFolderId()

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.