Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgAlarmConditionQuery

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

public class CfgAlarmConditionQuery
extends CfgFilterBasedQuery<CfgAlarmCondition>

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

See Also:
ConfService, CfgAlarmCondition

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

CfgAlarmConditionQuery

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


CfgAlarmConditionQuery

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

CfgAlarmConditionQuery

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

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

CfgAlarmConditionQuery

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

execute

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

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

beginExecute

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

setState

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

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

getState

public final CfgObjectState getState()
Current state of an alarm condition (see CfgObjectState ). If specified, Configuration Server will return information only about alarm conditions 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 alarm condition. Shall be specified as a character string. If specified, Configuration Server will return information only about the alarm condition(s) with that name.

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

getName

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

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

getDbid

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

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