Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgScriptQuery

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

public class CfgScriptQuery
extends CfgFilterBasedQuery<CfgScript>

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

See Also:
ConfService, CfgScript

Constructor Summary
CfgScriptQuery()
          Create query object with default filter value for configuration objects of CfgScript type.
CfgScriptQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgScript type.
CfgScriptQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgScriptQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgScript> beginExecute(Action<AsyncRequestResult<CfgScript>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgScript> execute()
          Executes the query and returns a list of CfgScript objects.
 CfgScript executeSingleResult()
          Executes a query the result of which is a single object.
 int getCapacityAgentDbid()
          A unique identifier of Person/Agent.
 int getCapacityAgentGroupDbid()
          Unique identifier of an AgentGroup.
 int getCapacityPlaceDbid()
          Unique identifier of a Place.
 int getCapacityPlaceGroupDbid()
          Unique identifier of a PlaceGroup.
 int getCapacityTenantDbid()
          A unique identifier of Tenant.
 int getDbid()
          A unique identifier of a script.
 int getExcludeBytecode()
          A flag controlling how the bytecode binary option from the userProperties field will be returned.
 int getExcludeLongstrings()
          A flag controlling how the string options longer that 255 chars userProperties field ( or options for objects that support them) field will be returned.
 java.lang.String getName()
          Name of a script.
 CfgScriptType getScriptType()
          Type of the script (see CfgScriptType ).
 CfgObjectState getState()
          Current state of a script (see CfgObjectState ).
 int getTenantDbid()
          A unique identifier of a tenant.
 void setCapacityAgentDbid(int value)
          A unique identifier of Person/Agent.
 void setCapacityAgentGroupDbid(int value)
          Unique identifier of an AgentGroup.
 void setCapacityPlaceDbid(int value)
          Unique identifier of a Place.
 void setCapacityPlaceGroupDbid(int value)
          Unique identifier of a PlaceGroup.
 void setCapacityTenantDbid(int value)
          A unique identifier of Tenant.
 void setDbid(int value)
          A unique identifier of a script.
 void setExcludeBytecode(int value)
          A flag controlling how the bytecode binary option from the userProperties field will be returned.
 void setExcludeLongstrings(int value)
          A flag controlling how the string options longer that 255 chars userProperties field ( or options for objects that support them) field will be returned.
 void setName(java.lang.String value)
          Name of a script.
 void setScriptType(CfgScriptType value)
          Type of the script (see CfgScriptType ).
 void setState(CfgObjectState value)
          Current state of a script (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

CfgScriptQuery

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


CfgScriptQuery

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

CfgScriptQuery

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

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

CfgScriptQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgScript> beginExecute(Action<AsyncRequestResult<CfgScript>> 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 script(s) 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 script(s) that belong to this tenant.

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

setScriptType

public final void setScriptType(CfgScriptType value)
Type of the script (see CfgScriptType ). If specified, Configuration Server will return information only about the script(s) of this type.

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

getScriptType

public final CfgScriptType getScriptType()
Type of the script (see CfgScriptType ). If specified, Configuration Server will return information only about the script(s) of this type.

Returns:
filter value or null (if applicable)
See Also:
setScriptType(CfgScriptType)

setState

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

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

getState

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

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

getDbid

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

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

setName

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

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

getName

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

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

setCapacityTenantDbid

public final void setCapacityTenantDbid(int value)
A unique identifier of Tenant. If specified, Configuration Server will return information only about the script that is associated with specified tenant.

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

getCapacityTenantDbid

public final int getCapacityTenantDbid()
A unique identifier of Tenant. If specified, Configuration Server will return information only about the script that is associated with specified tenant.

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

setCapacityAgentDbid

public final void setCapacityAgentDbid(int value)
A unique identifier of Person/Agent. If specified, Configuration Server will return information only about the script that is associated with specified agent.

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

getCapacityAgentDbid

public final int getCapacityAgentDbid()
A unique identifier of Person/Agent. If specified, Configuration Server will return information only about the script that is associated with specified agent.

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

setCapacityAgentGroupDbid

public final void setCapacityAgentGroupDbid(int value)
Unique identifier of an AgentGroup. If specified, Configuration Server will return information only about the script that associated with agent group.

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

getCapacityAgentGroupDbid

public final int getCapacityAgentGroupDbid()
Unique identifier of an AgentGroup. If specified, Configuration Server will return information only about the script that associated with agent group.

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

setCapacityPlaceDbid

public final void setCapacityPlaceDbid(int value)
Unique identifier of a Place. If specified, Configuration Server will return information only about the script that is associated with specified place.

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

getCapacityPlaceDbid

public final int getCapacityPlaceDbid()
Unique identifier of a Place. If specified, Configuration Server will return information only about the script that is associated with specified place.

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

setCapacityPlaceGroupDbid

public final void setCapacityPlaceGroupDbid(int value)
Unique identifier of a PlaceGroup. If specified, Configuration Server will return information only about the script that is associated with specified place group.

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

getCapacityPlaceGroupDbid

public final int getCapacityPlaceGroupDbid()
Unique identifier of a PlaceGroup. If specified, Configuration Server will return information only about the script that is associated with specified place group.

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

setExcludeBytecode

public final void setExcludeBytecode(int value)
A flag controlling how the bytecode binary option from the userProperties field will be returned. If set in the filter, Configuration Server will return an empty list under this option without regard to the actual content.

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

getExcludeBytecode

public final int getExcludeBytecode()
A flag controlling how the bytecode binary option from the userProperties field will be returned. If set in the filter, Configuration Server will return an empty list under this option without regard to the actual content.

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

setExcludeLongstrings

public final void setExcludeLongstrings(int value)
A flag controlling how the string options longer that 255 chars userProperties field ( or options for objects that support them) field will be returned. If set in the filter, Configuration Server will return an empty string under this option if value is changed to more than 255 Note: this option is also applicable to all configuration objects, not only Script

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

getExcludeLongstrings

public final int getExcludeLongstrings()
A flag controlling how the string options longer that 255 chars userProperties field ( or options for objects that support them) field will be returned. If set in the filter, Configuration Server will return an empty string under this option if value is changed to more than 255 Note: this option is also applicable to all configuration objects, not only Script

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