Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgCallingListQuery

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
      extended by com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery<CfgCallingList>
          extended by com.genesyslab.platform.applicationblocks.com.queries.CfgCallingListQuery
All Implemented Interfaces:
ICfgFilterBasedQuery<CfgCallingList>, ICfgQuery<CfgCallingList>, ICfgQueryObjectClass<CfgCallingList>

public class CfgCallingListQuery
extends CfgFilterBasedQuery<CfgCallingList>

Class designed to construct queries to the Configuration Service for reading CfgCallingList object(s).

See Also:
ConfService, CfgCallingList

Constructor Summary
CfgCallingListQuery()
          Create query object with default filter value for configuration objects of CfgCallingList type.
CfgCallingListQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgCallingList type.
CfgCallingListQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgCallingListQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgCallingList> beginExecute(Action<AsyncRequestResult<CfgCallingList>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgCallingList> execute()
          Executes the query and returns a list of CfgCallingList objects.
 CfgCallingList executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of the calling list.
 int getFilterDbid()
          A unique identifier of the filter.
 int getLogTableAccessDbid()
          A unique identifier of the log table access.
 java.lang.String getName()
          Name of a calling list.
 int getScriptDbid()
          A unique identifier of the calling list script.
 CfgObjectState getState()
          Current state of the campaign (See CfgObjectState ).
 int getTableAccessDbid()
          A unique identifier of the table access.
 int getTenantDbid()
          A unique identifier of the tenant.
 int getTreatmentDbid()
          A unique identifier of the treatment.
 void setDbid(int value)
          A unique identifier of the calling list.
 void setFilterDbid(int value)
          A unique identifier of the filter.
 void setLogTableAccessDbid(int value)
          A unique identifier of the log table access.
 void setName(java.lang.String value)
          Name of a calling list.
 void setScriptDbid(int value)
          A unique identifier of the calling list script.
 void setState(CfgObjectState value)
          Current state of the campaign (See CfgObjectState ).
 void setTableAccessDbid(int value)
          A unique identifier of the table access.
 void setTenantDbid(int value)
          A unique identifier of the tenant.
 void setTreatmentDbid(int value)
          A unique identifier of the treatment.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery
equals, getCfgObjectClass, getCfgObjectType, getDoRequestFolderId, getDoRequestObjectPath, getExtraFilter, getFilter, getInt, getProperty, getQueryObjectClass, getString, hashCode, setDoRequestFolderId, setDoRequestObjectPath, setObjectClass, setProperty, toString
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgQuery
beginExecute, endExecute, execute, 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

CfgCallingListQuery

public CfgCallingListQuery()
Create query object with default filter value for configuration objects of CfgCallingList type. This query will not be executable.


CfgCallingListQuery

public CfgCallingListQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgCallingList type. If an instance of the configuration service is provided, the query will be executable.

Parameters:
service - The configuration service to use when executing this query

CfgCallingListQuery

public CfgCallingListQuery(int dbid)
Create query object with filter initialized for the object DBID.

Parameters:
dbid - value for filter on object dbid
See Also:
setDbid(int)

CfgCallingListQuery

public CfgCallingListQuery(java.lang.String name)
Create query object with filter initialized for object name value.

Parameters:
name - value for filter on object name
See Also:
setName(String)
Method Detail

executeSingleResult

public CfgCallingList executeSingleResult()
                                   throws ConfigException
Executes a query the result of which is a single object. Exception will be thrown if multiple objects are returned by the configuration server.

Overrides:
executeSingleResult in class CfgQuery<CfgCallingList>
Returns:
the CfgCallingList object retrieved as a result of this operation
Throws:
ConfigException

execute

public java.util.Collection<CfgCallingList> execute()
                                             throws ConfigException,
                                                    java.lang.InterruptedException
Executes the query and returns a list of CfgCallingList objects.

Overrides:
execute in class CfgQuery<CfgCallingList>
Returns:
A collection of CfgCallingList objects
Throws:
ConfigException
java.lang.InterruptedException

beginExecute

public AsyncRequestResult<CfgCallingList> beginExecute(Action<AsyncRequestResult<CfgCallingList>> callback,
                                                       java.lang.Object state)
                                                throws ConfigException
Begins the asynchronous execution of the current query.

Parameters:
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:
AsyncRequestResult describing the current operation
Throws:
ConfigException

setDbid

public final void setDbid(int value)
A unique identifier of the calling list. If specified, configuration server will return information only about this calling list.

Parameters:
value - filter value on field "dbid".

getDbid

public final int getDbid()
A unique identifier of the calling list. If specified, configuration server will return information only about this calling list.

Returns:
filter value or null (if applicable)
See Also:
setDbid(int)

setTenantDbid

public final void setTenantDbid(int value)
A unique identifier of the tenant. If specified, Configuration server will return information only about the calling list(s) that belong to this tenant.

Parameters:
value - filter value on field "tenant_dbid".

getTenantDbid

public final int getTenantDbid()
A unique identifier of the tenant. If specified, Configuration server will return information only about the calling list(s) that belong to this tenant.

Returns:
filter value or null (if applicable)
See Also:
setTenantDbid(int)

setName

public final void setName(java.lang.String value)
Name of a calling list. Shall be specified as a character string. If specified, Configuration Server will return information only about the calling list(s) with that name.

Parameters:
value - filter value on field "name".

getName

public final java.lang.String getName()
Name of a calling list. Shall be specified as a character string. If specified, Configuration Server will return information only about the calling list(s) with that name.

Returns:
filter value or null (if applicable)
See Also:
setName(String)

setTableAccessDbid

public final void setTableAccessDbid(int value)
A unique identifier of the table access. If specified, Configuration Server will return information only about the calling lists(s) engaged with that table access.

Parameters:
value - filter value on field "table_access_dbid".

getTableAccessDbid

public final int getTableAccessDbid()
A unique identifier of the table access. If specified, Configuration Server will return information only about the calling lists(s) engaged with that table access.

Returns:
filter value or null (if applicable)
See Also:
setTableAccessDbid(int)

setFilterDbid

public final void setFilterDbid(int value)
A unique identifier of the filter. If specified, Configuration Server will return information only about the calling list(s) with that filter.

Parameters:
value - filter value on field "filter_dbid".

getFilterDbid

public final int getFilterDbid()
A unique identifier of the filter. If specified, Configuration Server will return information only about the calling list(s) with that filter.

Returns:
filter value or null (if applicable)
See Also:
setFilterDbid(int)

setTreatmentDbid

public final void setTreatmentDbid(int value)
A unique identifier of the treatment. If specified, Configuration Server will return information only about the calling list(s) with that treatment.

Parameters:
value - filter value on field "treatment_dbid".

getTreatmentDbid

public final int getTreatmentDbid()
A unique identifier of the treatment. If specified, Configuration Server will return information only about the calling list(s) with that treatment.

Returns:
filter value or null (if applicable)
See Also:
setTreatmentDbid(int)

setLogTableAccessDbid

public final void setLogTableAccessDbid(int value)
A unique identifier of the log table access. If specified, Configuration Server will return information only about the calling lists(s) engaged with that log table access.

Parameters:
value - filter value on field "log_table_access_dbid".

getLogTableAccessDbid

public final int getLogTableAccessDbid()
A unique identifier of the log table access. If specified, Configuration Server will return information only about the calling lists(s) engaged with that log table access.

Returns:
filter value or null (if applicable)
See Also:
setLogTableAccessDbid(int)

setScriptDbid

public final void setScriptDbid(int value)
A unique identifier of the calling list script. If specified, Configuration Server will return information only about the calling list(s) with that script.

Parameters:
value - filter value on field "script_dbid".

getScriptDbid

public final int getScriptDbid()
A unique identifier of the calling list script. If specified, Configuration Server will return information only about the calling list(s) with that script.

Returns:
filter value or null (if applicable)
See Also:
setScriptDbid(int)

setState

public final void setState(CfgObjectState value)
Current state of the campaign (See CfgObjectState ). If specified, Configuration Server will return information only about the campaign(s) that are currently in this state.

Parameters:
value - filter value on field "state".

getState

public final CfgObjectState getState()
Current state of the campaign (See CfgObjectState ). If specified, Configuration Server will return information only about the campaign(s) that are currently in this state.

Returns:
filter value or null (if applicable)
See Also:
setState(CfgObjectState)

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.