Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgTimeZoneQuery

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

public class CfgTimeZoneQuery
extends CfgFilterBasedQuery<CfgTimeZone>

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

See Also:
ConfService, CfgTimeZone

Constructor Summary
CfgTimeZoneQuery()
          Create query object with default filter value for configuration objects of CfgTimeZone type.
CfgTimeZoneQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgTimeZone type.
CfgTimeZoneQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgTimeZoneQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgTimeZone> beginExecute(Action<AsyncRequestResult<CfgTimeZone>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgTimeZone> execute()
          Executes the query and returns a list of CfgTimeZone objects.
 CfgTimeZone executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of the time zone.
 java.lang.String getName()
          Name of a time zone.
 java.lang.String getNameMsexplorer()
          A pointer to the time zone name used by Microsoft browser.
 java.lang.String getNameNetscape()
          A pointer to the time zone name used by Netscape Navigator browser.
 int getOffset()
          A time zone offset.
 CfgObjectState getState()
          Current state of the time zone (See CfgObjectState ).
 int getTenantDbid()
          A unique identifier of the tenant.
 void setDbid(int value)
          A unique identifier of the time zone.
 void setName(java.lang.String value)
          Name of a time zone.
 void setNameMsexplorer(java.lang.String value)
          A pointer to the time zone name used by Microsoft browser.
 void setNameNetscape(java.lang.String value)
          A pointer to the time zone name used by Netscape Navigator browser.
 void setOffset(int value)
          A time zone offset.
 void setState(CfgObjectState value)
          Current state of the time zone (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

CfgTimeZoneQuery

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


CfgTimeZoneQuery

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

CfgTimeZoneQuery

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

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

CfgTimeZoneQuery

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

execute

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

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

beginExecute

public AsyncRequestResult<CfgTimeZone> beginExecute(Action<AsyncRequestResult<CfgTimeZone>> 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 time zone. If specified, configuration server will return information only about this time zone.

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

getDbid

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

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 time zone(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 time zone(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 time zone. Shall be specified as a character string. If specified, Configuration Server will return information only about the time zone with that name.

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

getName

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

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

setOffset

public final void setOffset(int value)
A time zone offset. If specified, Configuration Server will return information only about the time zone(s) with that offset.

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

getOffset

public final int getOffset()
A time zone offset. If specified, Configuration Server will return information only about the time zone(s) with that offset.

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

setNameNetscape

public final void setNameNetscape(java.lang.String value)
A pointer to the time zone name used by Netscape Navigator browser. Shall be specified as a character string. If specified, Configuration Server will return information only about the time zone(s) with that name.

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

getNameNetscape

public final java.lang.String getNameNetscape()
A pointer to the time zone name used by Netscape Navigator browser. Shall be specified as a character string. If specified, Configuration Server will return information only about the time zone(s) with that name.

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

setNameMsexplorer

public final void setNameMsexplorer(java.lang.String value)
A pointer to the time zone name used by Microsoft browser. Shall be specified as a character string. If specified, Configuration Server will return information only about the time zone(s) with that name.

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

getNameMsexplorer

public final java.lang.String getNameMsexplorer()
A pointer to the time zone name used by Microsoft browser. Shall be specified as a character string. If specified, Configuration Server will return information only about the time zone(s) with that name.

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

setState

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

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

getState

public final CfgObjectState getState()
Current state of the time zone (See CfgObjectState ). If specified, Configuration Server will return information only about the time zone(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.