Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgDNQuery

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

public class CfgDNQuery
extends CfgFilterBasedQuery<CfgDN>

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

See Also:
ConfService, CfgDN

Constructor Summary
CfgDNQuery()
          Create query object with default filter value for configuration objects of CfgDN type.
CfgDNQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgDN type.
CfgDNQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgDNQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgDN> beginExecute(Action<AsyncRequestResult<CfgDN>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgDN> execute()
          Executes the query and returns a list of CfgDN objects.
 CfgDN executeSingleResult()
          Executes a query the result of which is a single object.
 java.lang.String getAssociation()
          An entity associated with a DN.
 int getDbid()
          A unique identifier of a DN.
 java.lang.String getDnNumber()
          Directory number of a DN.
 CfgDNType getDnType()
          Type of the DN (see CfgDNType ).
 int getGroupDbid()
          A unique identifier of the group of DNs.
 int getIvrDbid()
          A unique identifier of an IVR object (see CfgIVR ).
 java.lang.String getName()
          Name of a DN.
 int getNoPlaceDbid()
          Configuration Server will return information only about the DN(s) that ) that are allowed to be assigned to the place and not associated with any place.
 int getPlaceDbid()
          A unique identifier of a place.
 CfgObjectState getState()
          Current state of a DN (see CfgObjectState ).
 int getSwitchDbid()
          A unique identifier of a switch.
 int getTenantDbid()
          A unique identifier of a tenant.
 void setAssociation(java.lang.String value)
          An entity associated with a DN.
 void setDbid(int value)
          A unique identifier of a DN.
 void setDnNumber(java.lang.String value)
          Directory number of a DN.
 void setDnType(CfgDNType value)
          Type of the DN (see CfgDNType ).
 void setGroupDbid(int value)
          A unique identifier of the group of DNs.
 void setIvrDbid(int value)
          A unique identifier of an IVR object (see CfgIVR ).
 void setName(java.lang.String value)
          Name of a DN.
 void setNoPlaceDbid(int value)
          Configuration Server will return information only about the DN(s) that ) that are allowed to be assigned to the place and not associated with any place.
 void setPlaceDbid(int value)
          A unique identifier of a place.
 void setState(CfgObjectState value)
          Current state of a DN (see CfgObjectState ).
 void setSwitchDbid(int value)
          A unique identifier of a switch.
 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

CfgDNQuery

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


CfgDNQuery

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

CfgDNQuery

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

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

CfgDNQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgDN> beginExecute(Action<AsyncRequestResult<CfgDN>> 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 a DN. If specified, Configuration Server will return information only about this DN.

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

getDbid

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

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

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)

setSwitchDbid

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

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

getSwitchDbid

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

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

setDnType

public final void setDnType(CfgDNType value)
Type of the DN (see CfgDNType ). If specified, Configuration Server will return information only about the DNs of this type.

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

getDnType

public final CfgDNType getDnType()
Type of the DN (see CfgDNType ). If specified, Configuration Server will return information only about the DNs of this type.

Returns:
filter value or null (if applicable)
See Also:
setDnType(CfgDNType)

setPlaceDbid

public final void setPlaceDbid(int value)
A unique identifier of a place. If specified, Configuration Server will return information only about the DNs that are associated with this place.

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

getPlaceDbid

public final int getPlaceDbid()
A unique identifier of a place. If specified, Configuration Server will return information only about the DNs that are associated with this place.

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

setNoPlaceDbid

public final void setNoPlaceDbid(int value)
Configuration Server will return information only about the DN(s) that ) that are allowed to be assigned to the place and not associated with any place.

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

getNoPlaceDbid

public final int getNoPlaceDbid()
Configuration Server will return information only about the DN(s) that ) that are allowed to be assigned to the place and not associated with any place.

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

setGroupDbid

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

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

getGroupDbid

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

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

setAssociation

public final void setAssociation(java.lang.String value)
An entity associated with a DN. Shall be specified as a character string. If specified, Configuration Server will return information only about the DN(s) that are associated with this entity.

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

getAssociation

public final java.lang.String getAssociation()
An entity associated with a DN. Shall be specified as a character string. If specified, Configuration Server will return information only about the DN(s) that are associated with this entity.

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

setState

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

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

getState

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

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

setDnNumber

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

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

getDnNumber

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

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

setName

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

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

getName

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

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

setIvrDbid

public final void setIvrDbid(int value)
A unique identifier of an IVR object (see CfgIVR ). If specified, Configuration Server will return information only about the DN(s) which assigned to IVR Ports (see CfgIVRPort ) of this IVR object.

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

getIvrDbid

public final int getIvrDbid()
A unique identifier of an IVR object (see CfgIVR ). If specified, Configuration Server will return information only about the DN(s) which assigned to IVR Ports (see CfgIVRPort ) of this IVR object.

Returns:
filter value or null (if applicable)
See Also:
setIvrDbid(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.