Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgDNGroupQuery

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

public class CfgDNGroupQuery
extends CfgFilterBasedQuery<CfgDNGroup>

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

See Also:
ConfService, CfgDNGroup

Constructor Summary
CfgDNGroupQuery()
          Create query object with default filter value for configuration objects of CfgDNGroup type.
CfgDNGroupQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgDNGroup type.
CfgDNGroupQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgDNGroupQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgDNGroup> beginExecute(Action<AsyncRequestResult<CfgDNGroup>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgDNGroup> execute()
          Executes the query and returns a list of CfgDNGroup objects.
 CfgDNGroup executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of a group.
 int getDnDbid()
          A unique identifier of a DN.
 CfgDNGroupType getDnGroupType()
          Type of a DN group (see CfgDNGroupType ).
 java.lang.String getName()
          Name of a DN group.
 CfgObjectState getState()
          Current state of a DN group (see CfgObjectState ).
 int getTenantDbid()
          A unique identifier of a tenant.
 void setDbid(int value)
          A unique identifier of a group.
 void setDnDbid(int value)
          A unique identifier of a DN.
 void setDnGroupType(CfgDNGroupType value)
          Type of a DN group (see CfgDNGroupType ).
 void setName(java.lang.String value)
          Name of a DN group.
 void setState(CfgObjectState value)
          Current state of a DN group (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

CfgDNGroupQuery

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


CfgDNGroupQuery

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

CfgDNGroupQuery

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

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

CfgDNGroupQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgDNGroup> beginExecute(Action<AsyncRequestResult<CfgDNGroup>> 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 DN groups 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 DN groups that belong to this tenant.

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

setDnGroupType

public final void setDnGroupType(CfgDNGroupType value)
Type of a DN group (see CfgDNGroupType ). If specified, Configuration Server will return information only about the DN groups of this type.

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

getDnGroupType

public final CfgDNGroupType getDnGroupType()
Type of a DN group (see CfgDNGroupType ). If specified, Configuration Server will return information only about the DN groups of this type.

Returns:
filter value or null (if applicable)
See Also:
setDnGroupType(CfgDNGroupType)

setDnDbid

public final void setDnDbid(int value)
A unique identifier of a DN. If specified, Configuration Server will return information only about the DN groups this DN is assigned to.

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

getDnDbid

public final int getDnDbid()
A unique identifier of a DN. If specified, Configuration Server will return information only about the DN groups this DN is assigned to.

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

setState

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

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

getState

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

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

setName

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

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

getName

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

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

setDbid

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

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

getDbid

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

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.