Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgFieldQuery

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

public class CfgFieldQuery
extends CfgFilterBasedQuery<CfgField>

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

See Also:
ConfService, CfgField

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

CfgFieldQuery

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


CfgFieldQuery

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

CfgFieldQuery

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

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

CfgFieldQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgField> beginExecute(Action<AsyncRequestResult<CfgField>> 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 fields 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 fields 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 field. Shall be specified as a character string. If specified, Configuration Server will return information only about the field(s) with that name.

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

getName

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

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

setState

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

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

getState

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

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

setType

public final void setType(CfgDataType value)
A data type of field in data base(See type CfgDataType ). If specified, Configuration Server will return information only about fields that have this data type.

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

getType

public final CfgDataType getType()
A data type of field in data base(See type CfgDataType ). If specified, Configuration Server will return information only about fields that have this data type.

Returns:
filter value or null (if applicable)
See Also:
setType(CfgDataType)

setFieldType

public final void setFieldType(CfgFieldType value)
A field type (See type CfgFieldType ). If specified, Configuration Server will return information only about fields that have this field type.

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

getFieldType

public final CfgFieldType getFieldType()
A field type (See type CfgFieldType ). If specified, Configuration Server will return information only about fields that have this field type.

Returns:
filter value or null (if applicable)
See Also:
setFieldType(CfgFieldType)

setDbid

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

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

getDbid

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

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

setFormatDbid

public final void setFormatDbid(int value)
A unique identifier of format. If specified, configuration server will return information only about fields that belong to this format.

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

getFormatDbid

public final int getFormatDbid()
A unique identifier of format. If specified, configuration server will return information only about fields that belong to this format.

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