Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgFormatQuery

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

public class CfgFormatQuery
extends CfgFilterBasedQuery<CfgFormat>

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

See Also:
ConfService, CfgFormat

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

CfgFormatQuery

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


CfgFormatQuery

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

CfgFormatQuery

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

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

CfgFormatQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgFormat> beginExecute(Action<AsyncRequestResult<CfgFormat>> 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 the tenant. If specified, Configuration server will return information only about the formats 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 formats that belong to this tenant.

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

setState

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

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

getState

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

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

setDbid

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

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

getDbid

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

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

setName

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

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

getName

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

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

setFieldDbid

public final void setFieldDbid(int value)
A unique identifier of the field. If specified, Configuration Server will return information only about the format(s) which consists this field.

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

getFieldDbid

public final int getFieldDbid()
A unique identifier of the field. If specified, Configuration Server will return information only about the format(s) which consists this field.

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