Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgAgentGroupQuery

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

public class CfgAgentGroupQuery
extends CfgFilterBasedQuery<CfgAgentGroup>

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

See Also:
ConfService, CfgAgentGroup

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

CfgAgentGroupQuery

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


CfgAgentGroupQuery

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

CfgAgentGroupQuery

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

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

CfgAgentGroupQuery

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

execute

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

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

beginExecute

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

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

setPersonDbid

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

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

getPersonDbid

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

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

setState

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

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

getState

public final CfgObjectState getState()
Current state of an agent group (see CfgObjectState ). If specified, Configuration Server will return information only about agent 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 an agent 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 an agent 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.