Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgPersonQuery

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

public class CfgPersonQuery
extends CfgFilterBasedQuery<CfgPerson>

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

See Also:
ConfService, CfgPerson

Constructor Summary
CfgPersonQuery()
          Create query object with default filter value for configuration objects of CfgPerson type.
CfgPersonQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgPerson type.
CfgPersonQuery(int dbid)
          Create query object with filter initialized for the object DBID.
 
Method Summary
 AsyncRequestResult<CfgPerson> beginExecute(Action<AsyncRequestResult<CfgPerson>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgPerson> execute()
          Executes the query and returns a list of CfgPerson objects.
 CfgPerson executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of a person.
 java.lang.String getEmployeeId()
          Employee ID of a person.
 java.lang.String getFirstName()
          The name of a person.
 int getGroupDbid()
          A unique identifier of an agent group.
 int getIsAgent()
          Indicator of whether a person is an agent.
 java.lang.String getLastName()
          The last name of a person.
 int getLoginDbid()
          A unique identifier of an agent login.
 int getNoLoginDbid()
          Configuration Server will return information only about the agent(s) without login is currently assigned to.
 int getNoPlaceDbid()
          Configuration Server will return the information only about the agents that do not have default places associated with.
 int getSkillDbid()
          A unique identifier of a skill.
 CfgObjectState getState()
          Current state of a person (see type CfgObjectState ).
 int getSwitchDbid()
          A unique identifier of a Switch.
 int getTenantDbid()
          A unique identifier of a tenant.
 java.lang.String getUserName()
          User name of a person.
 void setDbid(int value)
          A unique identifier of a person.
 void setEmployeeId(java.lang.String value)
          Employee ID of a person.
 void setFirstName(java.lang.String value)
          The name of a person.
 void setGroupDbid(int value)
          A unique identifier of an agent group.
 void setIsAgent(int value)
          Indicator of whether a person is an agent.
 void setLastName(java.lang.String value)
          The last name of a person.
 void setLoginDbid(int value)
          A unique identifier of an agent login.
 void setNoLoginDbid(int value)
          Configuration Server will return information only about the agent(s) without login is currently assigned to.
 void setNoPlaceDbid(int value)
          Configuration Server will return the information only about the agents that do not have default places associated with.
 void setSkillDbid(int value)
          A unique identifier of a skill.
 void setState(CfgObjectState value)
          Current state of a person (see type CfgObjectState ).
 void setSwitchDbid(int value)
          A unique identifier of a Switch.
 void setTenantDbid(int value)
          A unique identifier of a tenant.
 void setUserName(java.lang.String value)
          User name of a person.
 
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

CfgPersonQuery

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


CfgPersonQuery

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

CfgPersonQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgPerson> beginExecute(Action<AsyncRequestResult<CfgPerson>> 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 persons 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 persons that belong to this tenant.

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

setIsAgent

public final void setIsAgent(int value)
Indicator of whether a person is an agent. If set to CFGTrue, Configuration Server will return information only about the persons who are agents. If set to CFGFalse, Configuration Server will return information only about the persons who are not agents.

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

getIsAgent

public final int getIsAgent()
Indicator of whether a person is an agent. If set to CFGTrue, Configuration Server will return information only about the persons who are agents. If set to CFGFalse, Configuration Server will return information only about the persons who are not agents.

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

setSkillDbid

public final void setSkillDbid(int value)
A unique identifier of a skill. If specified, Configuration Server will return information only about the agents who have this skill.

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

getSkillDbid

public final int getSkillDbid()
A unique identifier of a skill. If specified, Configuration Server will return information only about the agents who have this skill.

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

setGroupDbid

public final void setGroupDbid(int value)
A unique identifier of an agent group. If specified, Configuration Server will return information only about the agents who form this group.

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

getGroupDbid

public final int getGroupDbid()
A unique identifier of an agent group. If specified, Configuration Server will return information only about the agents who form this group.

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

setState

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

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

getState

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

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

setEmployeeId

public final void setEmployeeId(java.lang.String value)
Employee ID of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person(s) with this employee ID.

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

getEmployeeId

public final java.lang.String getEmployeeId()
Employee ID of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person(s) with this employee ID.

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

setLoginDbid

public final void setLoginDbid(int value)
A unique identifier of an agent login. If specified, Configuration Server will return information only about the agent this login is currently assigned to.

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

getLoginDbid

public final int getLoginDbid()
A unique identifier of an agent login. If specified, Configuration Server will return information only about the agent this login is currently assigned to.

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

setUserName

public final void setUserName(java.lang.String value)
User name of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person with this user name.

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

getUserName

public final java.lang.String getUserName()
User name of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person with this user name.

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

setDbid

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

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

getDbid

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

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

setNoLoginDbid

public final void setNoLoginDbid(int value)
Configuration Server will return information only about the agent(s) without login is currently assigned to.

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

getNoLoginDbid

public final int getNoLoginDbid()
Configuration Server will return information only about the agent(s) without login is currently assigned to.

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

setNoPlaceDbid

public final void setNoPlaceDbid(int value)
Configuration Server will return the information only about the agents that do not have default places associated with.

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

getNoPlaceDbid

public final int getNoPlaceDbid()
Configuration Server will return the information only about the agents that do not have default places associated with.

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

setFirstName

public final void setFirstName(java.lang.String value)
The name of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person with this name.

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

getFirstName

public final java.lang.String getFirstName()
The name of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person with this name.

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

setLastName

public final void setLastName(java.lang.String value)
The last name of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person with this last name.

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

getLastName

public final java.lang.String getLastName()
The last name of a person. Shall be specified as a character string. If specified, Configuration Server will return information only about the person with this last name.

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

setSwitchDbid

public final void setSwitchDbid(int value)
A unique identifier of a Switch. If specified, Configuration Server will return information only about the agent(s) that have associated Agent Logins belonged to that 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(s) that have associated Agent Logins belonged to that Switch.

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