Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgFolderQuery

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

public class CfgFolderQuery
extends CfgFilterBasedQuery<CfgFolder>

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

See Also:
ConfService, CfgFolder

Constructor Summary
CfgFolderQuery()
          Create query object with default filter value for configuration objects of CfgFolder type.
CfgFolderQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgFolder type.
CfgFolderQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgFolderQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgFolder> beginExecute(Action<AsyncRequestResult<CfgFolder>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgFolder> execute()
          Executes the query and returns a list of CfgFolder objects.
 CfgFolder executeSingleResult()
          Executes a query the result of which is a single object.
 int getDbid()
          A unique identifier of a folder.
 int getDefaultFolder()
          A flag which selects among the folders belonging to some owner object the topmost one, e.g.
 int getFolderClass()
          A class of a folder.
 java.lang.String getName()
          Name of a folder.
 int getObjectDbid()
          A unique identifier of a subordinate object.
 int getObjectType()
          A type of a subordinate object.
 int getOwnerDbid()
          A unique identifier of an owner object.
 int getOwnerType()
          A type of an owner object.
 CfgObjectState getState()
          Current state of a folder (see type CfgObjectState ).
 int getType()
          A type of a folder.
 void setDbid(int value)
          A unique identifier of a folder.
 void setDefaultFolder(int value)
          A flag which selects among the folders belonging to some owner object the topmost one, e.g.
 void setFolderClass(int value)
          A class of a folder.
 void setName(java.lang.String value)
          Name of a folder.
 void setObjectDbid(int value)
          A unique identifier of a subordinate object.
 void setObjectType(int value)
          A type of a subordinate object.
 void setOwnerDbid(int value)
          A unique identifier of an owner object.
 void setOwnerType(int value)
          A type of an owner object.
 void setState(CfgObjectState value)
          Current state of a folder (see type CfgObjectState ).
 void setType(int value)
          A type of a folder.
 
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

CfgFolderQuery

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


CfgFolderQuery

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

CfgFolderQuery

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

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

CfgFolderQuery

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

execute

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

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

beginExecute

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

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

getDbid

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

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

setName

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

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

getName

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

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

setOwnerDbid

public final void setOwnerDbid(int value)
A unique identifier of an owner object. If specified, Configuration Server will return information only about the folders that belong to this object. Must be used in conjunction with the owner_type filter.

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

getOwnerDbid

public final int getOwnerDbid()
A unique identifier of an owner object. If specified, Configuration Server will return information only about the folders that belong to this object. Must be used in conjunction with the owner_type filter.

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

setOwnerType

public final void setOwnerType(int value)
A type of an owner object. Must be used in conjunction with the owner_dbid filter.

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

getOwnerType

public final int getOwnerType()
A type of an owner object. Must be used in conjunction with the owner_dbid filter.

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

setType

public final void setType(int value)
A type of a folder. If specified, Configuration Server will return information only about folders of this type.

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

getType

public final int getType()
A type of a folder. If specified, Configuration Server will return information only about folders of this type.

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

setDefaultFolder

public final void setDefaultFolder(int value)
A flag which selects among the folders belonging to some owner object the topmost one, e.g. that which does not have a parent folder above. Must be used in conjunction with owner_type and owner_dbid filters. Most likely will be used with type filter.

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

getDefaultFolder

public final int getDefaultFolder()
A flag which selects among the folders belonging to some owner object the topmost one, e.g. that which does not have a parent folder above. Must be used in conjunction with owner_type and owner_dbid filters. Most likely will be used with type filter.

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

setObjectDbid

public final void setObjectDbid(int value)
A unique identifier of a subordinate object. If specified, Configuration Server will return information only about the folder that contains this object. Must be used in conjunction with the object_type filter.

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

getObjectDbid

public final int getObjectDbid()
A unique identifier of a subordinate object. If specified, Configuration Server will return information only about the folder that contains this object. Must be used in conjunction with the object_type filter.

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

setObjectType

public final void setObjectType(int value)
A type of a subordinate object. Must be used in conjunction with the object_dbid filter.

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

getObjectType

public final int getObjectType()
A type of a subordinate object. Must be used in conjunction with the object_dbid filter.

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

setState

public final void setState(CfgObjectState value)
Current state of a folder (see type CfgObjectState ). If specified, Configuration Server will return information only about folders that are currently in this state.

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

getState

public final CfgObjectState getState()
Current state of a folder (see type CfgObjectState ). If specified, Configuration Server will return information only about folders that are currently in this state.

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

setFolderClass

public final void setFolderClass(int value)
A class of a folder. If specified, Configuration Server will return information only about folders of this class.

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

getFolderClass

public final int getFolderClass()
A class of a folder. If specified, Configuration Server will return information only about folders of this class.

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