Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgAgentLoginQuery

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

public class CfgAgentLoginQuery
extends CfgFilterBasedQuery<CfgAgentLogin>

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

See Also:
ConfService, CfgAgentLogin

Constructor Summary
CfgAgentLoginQuery()
          Create query object with default filter value for configuration objects of CfgAgentLogin type.
CfgAgentLoginQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgAgentLogin type.
CfgAgentLoginQuery(int dbid)
          Create query object with filter initialized for the object DBID.
 
Method Summary
 AsyncRequestResult<CfgAgentLogin> beginExecute(Action<AsyncRequestResult<CfgAgentLogin>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgAgentLogin> execute()
          Executes the query and returns a list of CfgAgentLogin objects.
 CfgAgentLogin executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of an agent login.
 java.lang.String getLoginCode()
          Agent login code.
 int getNoPersonDbid()
          Configuration Server will return information only about agent logins that currently are not associated with any person.
 CfgObjectState getState()
          Current state of an agent login (see CfgObjectState ).
 int getSwitchDbid()
          A unique identifier of a switch.
 int getTenantDbid()
          A unique identifier of a tenant.
 void setDbid(int value)
          A unique identifier of an agent login.
 void setLoginCode(java.lang.String value)
          Agent login code.
 void setNoPersonDbid(int value)
          Configuration Server will return information only about agent logins that currently are not associated with any person.
 void setState(CfgObjectState value)
          Current state of an agent login (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

CfgAgentLoginQuery

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


CfgAgentLoginQuery

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

CfgAgentLoginQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgAgentLogin> beginExecute(Action<AsyncRequestResult<CfgAgentLogin>> 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 logins 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 logins 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 agent logins 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 agent logins that belong to this switch.

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

setState

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

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

getState

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

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

setLoginCode

public final void setLoginCode(java.lang.String value)
Agent login code. Shall be specified as a character string. If specified, Configuration Server will return information only about the agent login(s) with this code.

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

getLoginCode

public final java.lang.String getLoginCode()
Agent login code. Shall be specified as a character string. If specified, Configuration Server will return information only about the agent login(s) with this code.

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

setDbid

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

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

getDbid

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

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

setNoPersonDbid

public final void setNoPersonDbid(int value)
Configuration Server will return information only about agent logins that currently are not associated with any person.

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

getNoPersonDbid

public final int getNoPersonDbid()
Configuration Server will return information only about agent logins that currently are not associated with any person.

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