Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgRoleQuery

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

public class CfgRoleQuery
extends CfgFilterBasedQuery<CfgRole>

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

See Also:
ConfService, CfgRole

Constructor Summary
CfgRoleQuery()
          Create query object with default filter value for configuration objects of CfgRole type.
CfgRoleQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgRole type.
CfgRoleQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgRoleQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgRole> beginExecute(Action<AsyncRequestResult<CfgRole>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgRole> execute()
          Executes the query and returns a list of CfgRole objects.
 CfgRole executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of a role.
 java.lang.String getName()
          Name of a role.
 java.lang.String getRbacAppNs()
          If specified , Configuration Server will return information about all roles including current application user and containing userProperties string specified by filter.
 CfgObjectState getState()
          

Current state of a role (see CfgObjectState ).

 void setDbid(int value)
          A unique identifier of a role.
 void setName(java.lang.String value)
          Name of a role.
 void setRbacAppNs(java.lang.String value)
          If specified , Configuration Server will return information about all roles including current application user and containing userProperties string specified by filter.
 void setState(CfgObjectState value)
          

Current state of a role (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

CfgRoleQuery

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


CfgRoleQuery

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

CfgRoleQuery

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

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

CfgRoleQuery

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

execute

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

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

beginExecute

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

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

getDbid

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

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

setName

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

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

getName

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

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

setState

public final void setState(CfgObjectState value)

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

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

getState

public final CfgObjectState getState()

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

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

setRbacAppNs

public final void setRbacAppNs(java.lang.String value)
If specified , Configuration Server will return information about all roles including current application user and containing userProperties string specified by filter.

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

getRbacAppNs

public final java.lang.String getRbacAppNs()
If specified , Configuration Server will return information about all roles including current application user and containing userProperties string specified by filter.

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