Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgTableAccessQuery

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

public class CfgTableAccessQuery
extends CfgFilterBasedQuery<CfgTableAccess>

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

See Also:
ConfService, CfgTableAccess

Constructor Summary
CfgTableAccessQuery()
          Create query object with default filter value for configuration objects of CfgTableAccess type.
CfgTableAccessQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgTableAccess type.
CfgTableAccessQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgTableAccessQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgTableAccess> beginExecute(Action<AsyncRequestResult<CfgTableAccess>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgTableAccess> execute()
          Executes the query and returns a list of CfgTableAccess objects.
 CfgTableAccess executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbaccessDbid()
          A unique identifier of the data base access point through which the table can be accessed.
 int getDbid()
          A unique identifier of a table access.
 java.lang.String getDbTableName()
          Name of the table.
 int getFormatDbid()
          A unique identifier of format of the table.
 java.lang.String getName()
          Name of a table access.
 CfgObjectState getState()
          Current state of the table access (See CfgObjectState ).
 int getTenantDbid()
          A unique identifier of the tenant.
 CfgTableType getType()
          A type of table (See CfgTableType ).
 void setDbaccessDbid(int value)
          A unique identifier of the data base access point through which the table can be accessed.
 void setDbid(int value)
          A unique identifier of a table access.
 void setDbTableName(java.lang.String value)
          Name of the table.
 void setFormatDbid(int value)
          A unique identifier of format of the table.
 void setName(java.lang.String value)
          Name of a table access.
 void setState(CfgObjectState value)
          Current state of the table access (See CfgObjectState ).
 void setTenantDbid(int value)
          A unique identifier of the tenant.
 void setType(CfgTableType value)
          A type of table (See CfgTableType ).
 
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

CfgTableAccessQuery

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


CfgTableAccessQuery

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

CfgTableAccessQuery

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

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

CfgTableAccessQuery

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

execute

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

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

beginExecute

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

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

getDbid

public final int getDbid()
A unique identifier of a table access. If specified, configuration server will return information only about this table access.

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

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

getName

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

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

setType

public final void setType(CfgTableType value)
A type of table (See CfgTableType ). If specified, Configuration Server will return information only about the table(s) of that type.

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

getType

public final CfgTableType getType()
A type of table (See CfgTableType ). If specified, Configuration Server will return information only about the table(s) of that type.

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

setDbaccessDbid

public final void setDbaccessDbid(int value)
A unique identifier of the data base access point through which the table can be accessed. If specified, Configuration Server will return information only about the table access(es) which consists this data base access point.

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

getDbaccessDbid

public final int getDbaccessDbid()
A unique identifier of the data base access point through which the table can be accessed. If specified, Configuration Server will return information only about the table access(es) which consists this data base access point.

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

setFormatDbid

public final void setFormatDbid(int value)
A unique identifier of format of the table. If specified, Configuration Server will return information only about the table(s) with that format.

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

getFormatDbid

public final int getFormatDbid()
A unique identifier of format of the table. If specified, Configuration Server will return information only about the table(s) with that format.

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

setDbTableName

public final void setDbTableName(java.lang.String value)
Name of the table. Shall be specified as a character string. If specified, Configuration Server will return information only about the table access(es) for that table.

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

getDbTableName

public final java.lang.String getDbTableName()
Name of the table. Shall be specified as a character string. If specified, Configuration Server will return information only about the table access(es) for that table.

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

setState

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

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

getState

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