Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgPlaceGroupQuery

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

public class CfgPlaceGroupQuery
extends CfgFilterBasedQuery<CfgPlaceGroup>

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

See Also:
ConfService, CfgPlaceGroup

Constructor Summary
CfgPlaceGroupQuery()
          Create query object with default filter value for configuration objects of CfgPlaceGroup type.
CfgPlaceGroupQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgPlaceGroup type.
CfgPlaceGroupQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgPlaceGroupQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgPlaceGroup> beginExecute(Action<AsyncRequestResult<CfgPlaceGroup>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgPlaceGroup> execute()
          Executes the query and returns a list of CfgPlaceGroup objects.
 CfgPlaceGroup 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 a place group.
 int getPlaceDbid()
          A unique identifier of a place.
 CfgObjectState getState()
          Current state of a place 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 a place group.
 void setPlaceDbid(int value)
          A unique identifier of a place.
 void setState(CfgObjectState value)
          Current state of a place 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

CfgPlaceGroupQuery

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


CfgPlaceGroupQuery

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

CfgPlaceGroupQuery

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

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

CfgPlaceGroupQuery

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

execute

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

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

beginExecute

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

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

setPlaceDbid

public final void setPlaceDbid(int value)
A unique identifier of a place. If specified, Configuration Server will return information only about the place groups that include 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 place groups that include this place.

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

setState

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

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

getState

public final CfgObjectState getState()
Current state of a place group (see CfgObjectState ). If specified, Configuration Server will return information only about place 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 place group. Shall be specified as a character string. If specified, Configuration Server will return information only about the place group(s) with that name.

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

getName

public final java.lang.String getName()
Name of a place group. Shall be specified as a character string. If specified, Configuration Server will return information only about the place 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.