Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgTransactionQuery

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

public class CfgTransactionQuery
extends CfgFilterBasedQuery<CfgTransaction>

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

See Also:
ConfService, CfgTransaction

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

CfgTransactionQuery

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


CfgTransactionQuery

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

CfgTransactionQuery

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

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

CfgTransactionQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgTransaction> beginExecute(Action<AsyncRequestResult<CfgTransaction>> 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 transactions 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 transactions that belong to this tenant.

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

setObjectType

public final void setObjectType(CfgTransactionType value)
Type of the object (see CfgTransactionType ). If specified, Configuration Server will return information only about the transactions of this type.

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

getObjectType

public final CfgTransactionType getObjectType()
Type of the object (see CfgTransactionType ). If specified, Configuration Server will return information only about the transactions of this type.

Returns:
filter value or null (if applicable)
See Also:
setObjectType(CfgTransactionType)

setState

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

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

getState

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

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

getDbid

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

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

setName

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

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

getName

public final java.lang.String getName()
Name of a transaction. Shall be specified as a character string. If specified, Configuration Server will return information only about the transaction(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.