Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgServiceQuery

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

public class CfgServiceQuery
extends CfgFilterBasedQuery<CfgService>

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

See Also:
ConfService, CfgService

Constructor Summary
CfgServiceQuery()
          Create query object with default filter value for configuration objects of CfgService type.
CfgServiceQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgService type.
CfgServiceQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgServiceQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgService> beginExecute(Action<AsyncRequestResult<CfgService>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgService> execute()
          Executes the query and returns a list of CfgService objects.
 CfgService executeSingleResult()
          Executes a query the result of which is a single object.
 int getAppDbid()
          A unique identifier of an application.
 CfgAppType getAppType()
          

Type of the application (see CfgAppType ).

 int getDbid()
          A unique identifier of a service.
 int getFolderDbid()
          A unique identifier of a folder.
 java.lang.String getName()
          Name of a service.
 int getScsDbid()
          A unique identifier of a Service Control Server.
 CfgObjectState getState()
          

Current state of a service (see CfgObjectState ).

 int getTenantDbid()
          A unique identifier of a tenant.
 int getType()
          The type of the solution.
 void setAppDbid(int value)
          A unique identifier of an application.
 void setAppType(CfgAppType value)
          

Type of the application (see CfgAppType ).

 void setDbid(int value)
          A unique identifier of a service.
 void setFolderDbid(int value)
          A unique identifier of a folder.
 void setName(java.lang.String value)
          Name of a service.
 void setScsDbid(int value)
          A unique identifier of a Service Control Server.
 void setState(CfgObjectState value)
          

Current state of a service (see CfgObjectState ).

 void setTenantDbid(int value)
          A unique identifier of a tenant.
 void setType(int value)
          The type of the solution.
 
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

CfgServiceQuery

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


CfgServiceQuery

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

CfgServiceQuery

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

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

CfgServiceQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgService> beginExecute(Action<AsyncRequestResult<CfgService>> 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 a service. If specified, Configuration Server will return information only about this service.

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

getDbid

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

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

setName

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

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

getName

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

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 services this tenant is subscribed to.

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

setAppType

public final void setAppType(CfgAppType value)

Type of the application (see CfgAppType ). If specified, Configuration Server will return information only about the services that involve this application type.

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

getAppType

public final CfgAppType getAppType()

Type of the application (see CfgAppType ). If specified, Configuration Server will return information only about the services that involve this application type.

Returns:
filter value or null (if applicable)
See Also:
setAppType(CfgAppType)

setState

public final void setState(CfgObjectState value)

Current state of a service (see CfgObjectState ). If specified, Configuration Server will return information only about services that are currently in this state.

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

getState

public final CfgObjectState getState()

Current state of a service (see CfgObjectState ). If specified, Configuration Server will return information only about services that are currently in this state.

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

setAppDbid

public final void setAppDbid(int value)
A unique identifier of an application. If specified, Configuration Server will return information only about the Solutions that involve this application.

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

getAppDbid

public final int getAppDbid()
A unique identifier of an application. If specified, Configuration Server will return information only about the Solutions that involve this application.

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

setScsDbid

public final void setScsDbid(int value)
A unique identifier of a Service Control Server. If specified, Configuration Server will return information only about the solutions controlled by this SCS.

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

getScsDbid

public final int getScsDbid()
A unique identifier of a Service Control Server. If specified, Configuration Server will return information only about the solutions controlled by this SCS.

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

setType

public final void setType(int value)
The type of the solution. If specified, Configuration Server will return information only about the solutions of specified type.

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

getType

public final int getType()
The type of the solution. If specified, Configuration Server will return information only about the solutions of specified type.

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

setFolderDbid

public final void setFolderDbid(int value)
A unique identifier of a folder. If specified, Configuration Server will return information only about the services located immediately under this folder.

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

getFolderDbid

public final int getFolderDbid()
A unique identifier of a folder. If specified, Configuration Server will return information only about the services located immediately under this folder.

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