Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgIVRPortQuery

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

public class CfgIVRPortQuery
extends CfgFilterBasedQuery<CfgIVRPort>

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

See Also:
ConfService, CfgIVRPort

Constructor Summary
CfgIVRPortQuery()
          Create query object with default filter value for configuration objects of CfgIVRPort type.
CfgIVRPortQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgIVRPort type.
CfgIVRPortQuery(int dbid)
          Create query object with filter initialized for the object DBID.
 
Method Summary
 AsyncRequestResult<CfgIVRPort> beginExecute(Action<AsyncRequestResult<CfgIVRPort>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgIVRPort> execute()
          Executes the query and returns a list of CfgIVRPort objects.
 CfgIVRPort executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of the IVR port.
 int getDnDbid()
          A unique identifier of the DN.
 int getIvrDbid()
          A unique identifier of the IVR.
 java.lang.String getPortNumber()
          A port number.
 CfgObjectState getState()
          Current state of a IVR port (see CfgObjectState ).
 int getTenantDbid()
          A unique identifier of a tenant.
 void setDbid(int value)
          A unique identifier of the IVR port.
 void setDnDbid(int value)
          A unique identifier of the DN.
 void setIvrDbid(int value)
          A unique identifier of the IVR.
 void setPortNumber(java.lang.String value)
          A port number.
 void setState(CfgObjectState value)
          Current state of a IVR port (see CfgObjectState ).
 void setTenantDbid(int value)
          A unique identifier of a 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

CfgIVRPortQuery

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


CfgIVRPortQuery

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

CfgIVRPortQuery

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

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

executeSingleResult

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgIVRPort> beginExecute(Action<AsyncRequestResult<CfgIVRPort>> 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 IVR ports 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 IVR ports that belong to this tenant.

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

setState

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

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

getState

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

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

setIvrDbid

public final void setIvrDbid(int value)
A unique identifier of the IVR. If specified, Configuration Server will return the information only about the IVR ports that belong to this IVR.

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

getIvrDbid

public final int getIvrDbid()
A unique identifier of the IVR. If specified, Configuration Server will return the information only about the IVR ports that belong to this IVR.

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

setDnDbid

public final void setDnDbid(int value)
A unique identifier of the DN. If specified, configuration Server will return the information about IVR port associated with this DN.

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

getDnDbid

public final int getDnDbid()
A unique identifier of the DN. If specified, configuration Server will return the information about IVR port associated with this DN.

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

setPortNumber

public final void setPortNumber(java.lang.String value)
A port number. Shall be specified as a character string. If specified, Configuration Server will return information only about the port(s) with that number.

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

getPortNumber

public final java.lang.String getPortNumber()
A port number. Shall be specified as a character string. If specified, Configuration Server will return information only about the port(s) with that number.

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

setDbid

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

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

getDbid

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

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.