Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgFilterQuery

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

public class CfgFilterQuery
extends CfgFilterBasedQuery<CfgFilter>

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

See Also:
ConfService, CfgFilter

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

CfgFilterQuery

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


CfgFilterQuery

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

CfgFilterQuery

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

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

CfgFilterQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgFilter> beginExecute(Action<AsyncRequestResult<CfgFilter>> 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

setDbid

public final void setDbid(int value)
A unique identifier of the filter. If specified, configuration server will return information only about this filter.

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

getDbid

public final int getDbid()
A unique identifier of the filter. If specified, configuration server will return information only about this filter.

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

setTenantDbid

public final void setTenantDbid(int value)
A unique identifier of the tenant. If specified, Configuration server will return information only about the filter(s) that belong to this tenant.

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

getTenantDbid

public final int getTenantDbid()
A unique identifier of the tenant. If specified, Configuration server will return information only about the filter(s) that belong to this tenant.

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

setName

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

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

getName

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

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

setFormatDbid

public final void setFormatDbid(int value)
A unique identifier of format this filter relates to. If specified, Configuration Server will return information only about the filter(s) with that format.

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

getFormatDbid

public final int getFormatDbid()
A unique identifier of format this filter relates to. If specified, Configuration Server will return information only about the filter(s) with that format.

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

setState

public final void setState(CfgObjectState value)
Current state of the filter (See CfgObjectState ). If specified, Configuration Server will return information only about the filter(s) that are currently in this state.

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

getState

public final CfgObjectState getState()
Current state of the filter (See CfgObjectState ). If specified, Configuration Server will return information only about the filter(s) that are currently in this state.

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

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.