Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgCampaignQuery

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

public class CfgCampaignQuery
extends CfgFilterBasedQuery<CfgCampaign>

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

See Also:
ConfService, CfgCampaign

Constructor Summary
CfgCampaignQuery()
          Create query object with default filter value for configuration objects of CfgCampaign type.
CfgCampaignQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgCampaign type.
CfgCampaignQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgCampaignQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgCampaign> beginExecute(Action<AsyncRequestResult<CfgCampaign>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgCampaign> execute()
          Executes the query and returns a list of CfgCampaign objects.
 CfgCampaign executeSingleResult()
          Executes a query the result of which is a single object.
 int getCallingListDbid()
          A unique identifier of calling list.
 int getDbid()
          A unique identifier of the campaign.
 int getGroupDbid()
          A unique identifier of group. If specified, Configuration Server will return information only about the campaign(s) with that group.
 java.lang.String getName()
          Name of a campaign.
 int getScriptDbid()
          A unique identifier of the campaign script.
 CfgObjectState getState()
          Current state of the campaign (See CfgObjectState ).
 int getTenantDbid()
          A unique identifier of the tenant.
 void setCallingListDbid(int value)
          A unique identifier of calling list.
 void setDbid(int value)
          A unique identifier of the campaign.
 void setGroupDbid(int value)
          A unique identifier of group. If specified, Configuration Server will return information only about the campaign(s) with that group.
 void setName(java.lang.String value)
          Name of a campaign.
 void setScriptDbid(int value)
          A unique identifier of the campaign script.
 void setState(CfgObjectState value)
          Current state of the campaign (See CfgObjectState ).
 void setTenantDbid(int value)
          A unique identifier of the tenant.
 
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

CfgCampaignQuery

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


CfgCampaignQuery

public CfgCampaignQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgCampaign 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

CfgCampaignQuery

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

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

CfgCampaignQuery

public CfgCampaignQuery(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 CfgCampaign 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<CfgCampaign>
Returns:
the CfgCampaign object retrieved as a result of this operation
Throws:
ConfigException

execute

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

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

beginExecute

public AsyncRequestResult<CfgCampaign> beginExecute(Action<AsyncRequestResult<CfgCampaign>> 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 campaign. If specified, configuration server will return information only about this campaign.

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

getDbid

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

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 campaign(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 campaign(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 campaign. Shall be specified as a character string. If specified, Configuration Server will return information only about the campaign(s) with that name.

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

getName

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

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

setGroupDbid

public final void setGroupDbid(int value)
A unique identifier of group. If specified, Configuration Server will return information only about the campaign(s) with that group.

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

getGroupDbid

public final int getGroupDbid()
A unique identifier of group. If specified, Configuration Server will return information only about the campaign(s) with that group.

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

setCallingListDbid

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

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

getCallingListDbid

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

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

setScriptDbid

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

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

getScriptDbid

public final int getScriptDbid()
A unique identifier of the campaign script. If specified, Configuration Server will return information only about the campaign(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.