Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgTreatmentQuery

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

public class CfgTreatmentQuery
extends CfgFilterBasedQuery<CfgTreatment>

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

See Also:
ConfService, CfgTreatment

Constructor Summary
CfgTreatmentQuery()
          Create query object with default filter value for configuration objects of CfgTreatment type.
CfgTreatmentQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgTreatment type.
CfgTreatmentQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgTreatmentQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgTreatment> beginExecute(Action<AsyncRequestResult<CfgTreatment>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgTreatment> execute()
          Executes the query and returns a list of CfgTreatment objects.
 CfgTreatment executeSingleResult()
          Executes a query the result of which is a single object.
 CfgCallActionCode getCallActionCode()
          A call action code(See CfgCallActionCode ).
 GctiCallState getCallResult()
          A call result related to this treatment (See GctiCallState ).
 int getDbid()
          A unique identifier of the treatment.
 int getDestDnDbid()
          A unique identifier of destination dn.
 java.lang.String getName()
          Name of a treatment.
 CfgRecActionCode getRecActionCode()
          A record action code(See CfgRecActionCode ).
 CfgObjectState getState()
          Current state of the table access (See CfgObjectState ).
 int getTenantDbid()
          A unique identifier of the tenant.
 void setCallActionCode(CfgCallActionCode value)
          A call action code(See CfgCallActionCode ).
 void setCallResult(GctiCallState value)
          A call result related to this treatment (See GctiCallState ).
 void setDbid(int value)
          A unique identifier of the treatment.
 void setDestDnDbid(int value)
          A unique identifier of destination dn.
 void setName(java.lang.String value)
          Name of a treatment.
 void setRecActionCode(CfgRecActionCode value)
          A record action code(See CfgRecActionCode ).
 void setState(CfgObjectState value)
          Current state of the table access (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

CfgTreatmentQuery

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


CfgTreatmentQuery

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

CfgTreatmentQuery

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

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

CfgTreatmentQuery

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

execute

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

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

beginExecute

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

setDbid

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

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

getDbid

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

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

setTenantDbid

public final void setTenantDbid(int value)
A unique identifier of the tenant. If specified, Configuration server will return information only about the treatment(s) 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 treatment(s) 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 treatment. Shall be specified as a character string. If specified, Configuration Server will return information only about the treatment(s) with that name.

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

getName

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

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

setCallResult

public final void setCallResult(GctiCallState value)
A call result related to this treatment (See GctiCallState ). If specified, Configuration Server will return information only about the treatments(s) with that call result.

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

getCallResult

public final GctiCallState getCallResult()
A call result related to this treatment (See GctiCallState ). If specified, Configuration Server will return information only about the treatments(s) with that call result.

Returns:
filter value or null (if applicable)
See Also:
setCallResult(GctiCallState)

setRecActionCode

public final void setRecActionCode(CfgRecActionCode value)
A record action code(See CfgRecActionCode ). If specified, Configuration Server will return information only about the treatments(s) with that record action code.

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

getRecActionCode

public final CfgRecActionCode getRecActionCode()
A record action code(See CfgRecActionCode ). If specified, Configuration Server will return information only about the treatments(s) with that record action code.

Returns:
filter value or null (if applicable)
See Also:
setRecActionCode(CfgRecActionCode)

setDestDnDbid

public final void setDestDnDbid(int value)
A unique identifier of destination dn. If specified, Configuration Server will return information only about the treatments(s) with that destination dn specified.

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

getDestDnDbid

public final int getDestDnDbid()
A unique identifier of destination dn. If specified, Configuration Server will return information only about the treatments(s) with that destination dn specified.

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

setCallActionCode

public final void setCallActionCode(CfgCallActionCode value)
A call action code(See CfgCallActionCode ). If specified, Configuration Server will return information only about the treatments(s) with that call action code.

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

getCallActionCode

public final CfgCallActionCode getCallActionCode()
A call action code(See CfgCallActionCode ). If specified, Configuration Server will return information only about the treatments(s) with that call action code.

Returns:
filter value or null (if applicable)
See Also:
setCallActionCode(CfgCallActionCode)

setState

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

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

getState

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

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

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.