Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgAppPrototypeQuery

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

public class CfgAppPrototypeQuery
extends CfgFilterBasedQuery<CfgAppPrototype>

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

See Also:
ConfService, CfgAppPrototype

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

CfgAppPrototypeQuery

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


CfgAppPrototypeQuery

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

CfgAppPrototypeQuery

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

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

CfgAppPrototypeQuery

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

execute

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

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

beginExecute

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

setAppType

public final void setAppType(CfgAppType value)
Type of the application (see type CfgAppType ). If specified, Configuration Server will return information only about the application prototypes that relates to the applications of this type.

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

getAppType

public final CfgAppType getAppType()
Type of the application (see type CfgAppType ). If specified, Configuration Server will return information only about the application prototypes that relates to the applications of this type.

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

setState

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

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

getState

public final CfgObjectState getState()
Current state of an application prototype (see CfgObjectState ). If specified, Configuration Server will return information only about application prototypes that are currently in this state.

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

setName

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

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

getName

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

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

setDbid

public final void setDbid(int value)
A unique identifier of an application. If specified, Configuration Server will return information only about this application prototype.

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

getDbid

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

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

setVersion

public final void setVersion(java.lang.String value)
A version of the application. Shall be specified as a character string. If specified, Configuration Server will return information only about application prototypes with that version.

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

getVersion

public final java.lang.String getVersion()
A version of the application. Shall be specified as a character string. If specified, Configuration Server will return information only about application prototypes with that version.

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