Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgEnumeratorValueQuery

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

public class CfgEnumeratorValueQuery
extends CfgFilterBasedQuery<CfgEnumeratorValue>

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

See Also:
ConfService, CfgEnumeratorValue

Constructor Summary
CfgEnumeratorValueQuery()
          Create query object with default filter value for configuration objects of CfgEnumeratorValue type.
CfgEnumeratorValueQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgEnumeratorValue type.
CfgEnumeratorValueQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgEnumeratorValueQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgEnumeratorValue> beginExecute(Action<AsyncRequestResult<CfgEnumeratorValue>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgEnumeratorValue> execute()
          Executes the query and returns a list of CfgEnumeratorValue objects.
 CfgEnumeratorValue executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of an enumerator value.
 int getDefaultValue()
          A default value of an enumerator.
 java.lang.String getDisplayName()
          Display name of an enumerator value.
 int getEnumeratorDbid()
          A unique identifier of an enumerator.
 java.lang.String getName()
          System name of an enumerator value.
 CfgObjectState getState()
          Current state of a enumerator value(see CfgObjectState ).
 int getTenantDbid()
          A unique identifier of a tenant.
 void setDbid(int value)
          A unique identifier of an enumerator value.
 void setDefaultValue(int value)
          A default value of an enumerator.
 void setDisplayName(java.lang.String value)
          Display name of an enumerator value.
 void setEnumeratorDbid(int value)
          A unique identifier of an enumerator.
 void setName(java.lang.String value)
          System name of an enumerator value.
 void setState(CfgObjectState value)
          Current state of a enumerator value(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

CfgEnumeratorValueQuery

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


CfgEnumeratorValueQuery

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

CfgEnumeratorValueQuery

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

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

CfgEnumeratorValueQuery

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

execute

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

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

beginExecute

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

setEnumeratorDbid

public final void setEnumeratorDbid(int value)
A unique identifier of an enumerator. If specified, Configuration Server will return information only about enumerator values for this enumerator.

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

getEnumeratorDbid

public final int getEnumeratorDbid()
A unique identifier of an enumerator. If specified, Configuration Server will return information only about enumerator values for this enumerator.

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

setDefaultValue

public final void setDefaultValue(int value)
A default value of an enumerator. If specified, Configuration Server will return information only about enumerator values with this flag set to CFGTrue.

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

getDefaultValue

public final int getDefaultValue()
A default value of an enumerator. If specified, Configuration Server will return information only about enumerator values with this flag set to CFGTrue.

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

setDbid

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

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

getDbid

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

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

setName

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

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

getName

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

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

setTenantDbid

public final void setTenantDbid(int value)
A unique identifier of a tenant. If specified, Configuration Server will return information only about the enumerator values 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 enumerator values 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 a enumerator value(see CfgObjectState ). If specified, Configuration Server will return information only about enumerator values that are currently in this state.

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

getState

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

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

setDisplayName

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

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

getDisplayName

public final java.lang.String getDisplayName()
Display name of an enumerator value. Shall be specified as a character string. If specified, Configuration Server will return information only about the enumerator(s) with that display name.

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

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.