Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgIVRQuery

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

public class CfgIVRQuery
extends CfgFilterBasedQuery<CfgIVR>

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

See Also:
ConfService, CfgIVR

Constructor Summary
CfgIVRQuery()
          Create query object with default filter value for configuration objects of CfgIVR type.
CfgIVRQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgIVR type.
CfgIVRQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgIVRQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgIVR> beginExecute(Action<AsyncRequestResult<CfgIVR>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgIVR> execute()
          Executes the query and returns a list of CfgIVR objects.
 CfgIVR executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of an IVR.
 int getIvrServerDbid()
          A unique identifier of an IVR interface server.
 java.lang.String getName()
          Name of IVR.
 CfgObjectState getState()
          Current state of an IVR (see CfgObjectState ).
 int getTenantDbid()
          A unique identifier of a tenant.
 CfgIVRType getType()
          Type of the IVR (see type CfgIVRType ).
 void setDbid(int value)
          A unique identifier of an IVR.
 void setIvrServerDbid(int value)
          A unique identifier of an IVR interface server.
 void setName(java.lang.String value)
          Name of IVR.
 void setState(CfgObjectState value)
          Current state of an IVR (see CfgObjectState ).
 void setTenantDbid(int value)
          A unique identifier of a tenant.
 void setType(CfgIVRType value)
          Type of the IVR (see type CfgIVRType ).
 
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

CfgIVRQuery

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


CfgIVRQuery

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

CfgIVRQuery

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

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

CfgIVRQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgIVR> beginExecute(Action<AsyncRequestResult<CfgIVR>> 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

setTenantDbid

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

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

getTenantDbid

public final int getTenantDbid()
A unique identifier of a tenant. If specified, Configuration Server will return information only about the DNs 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 IVR. Shall be specified as a character string. If specified, Configuration Server will return information only about the IVR with that name.

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

getName

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

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

setType

public final void setType(CfgIVRType value)
Type of the IVR (see type CfgIVRType ). If specified, Configuration Server will return information only about the IVR of this type.

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

getType

public final CfgIVRType getType()
Type of the IVR (see type CfgIVRType ). If specified, Configuration Server will return information only about the IVR of this type.

Returns:
filter value or null (if applicable)
See Also:
setType(CfgIVRType)

setIvrServerDbid

public final void setIvrServerDbid(int value)
A unique identifier of an IVR interface server. If specified, Configuration Server will return information only about the IVRs that associated with this IVR interface server.

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

getIvrServerDbid

public final int getIvrServerDbid()
A unique identifier of an IVR interface server. If specified, Configuration Server will return information only about the IVRs that associated with this IVR interface server.

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

setState

public final void setState(CfgObjectState value)
Current state of an IVR (see CfgObjectState ). If specified, Configuration Server will return information only about IVRs that are currently in this state.

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

getState

public final CfgObjectState getState()
Current state of an IVR (see CfgObjectState ). If specified, Configuration Server will return information only about IVRs that are currently in this state.

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

setDbid

public final void setDbid(int value)
A unique identifier of an IVR. If specified, Configuration Server will return information only about this IVR.

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

getDbid

public final int getDbid()
A unique identifier of an IVR. If specified, Configuration Server will return information only about this IVR.

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

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.