Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgActionCodeQuery

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

public class CfgActionCodeQuery
extends CfgFilterBasedQuery<CfgActionCode>

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

See Also:
ConfService, CfgActionCode

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

CfgActionCodeQuery

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


CfgActionCodeQuery

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

CfgActionCodeQuery

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

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

CfgActionCodeQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgActionCode> beginExecute(Action<AsyncRequestResult<CfgActionCode>> 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 action codes 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 action codes that belong to this tenant.

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

setCodeType

public final void setCodeType(CfgActionCodeType value)
Type of the action code (see CfgActionCodeType ). If specified, Configuration Server will return information only about the action codes of this type.

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

getCodeType

public final CfgActionCodeType getCodeType()
Type of the action code (see CfgActionCodeType ). If specified, Configuration Server will return information only about the action codes of this type.

Returns:
filter value or null (if applicable)
See Also:
setCodeType(CfgActionCodeType)

setState

public final void setState(CfgObjectState value)
Current state of an action code (see CfgObjectState ). If specified, Configuration Server will return information only about action codes that are currently in this state.

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

getState

public final CfgObjectState getState()
Current state of an action code (see CfgObjectState ). If specified, Configuration Server will return information only about action codes 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 an action code. If specified, Configuration Server will return information only about this action code.

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

getDbid

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

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

setName

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

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

getName

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

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