|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery<CfgFolder>
com.genesyslab.platform.applicationblocks.com.queries.CfgFolderQuery
public class CfgFolderQuery
Class designed to construct queries to the Configuration Service for reading CfgFolder object(s).
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 |
---|
public CfgFolderQuery()
public CfgFolderQuery(IConfService service)
service
- The configuration service to use when executing this querypublic CfgFolderQuery(int dbid)
dbid
- value for filter on object dbidsetDbid(int)
public CfgFolderQuery(java.lang.String name)
name
- value for filter on object namesetName(String)
Method Detail |
---|
public CfgFolder executeSingleResult() throws ConfigException
executeSingleResult
in class CfgQuery<CfgFolder>
ConfigException
public java.util.Collection<CfgFolder> execute() throws ConfigException, java.lang.InterruptedException
execute
in class CfgQuery<CfgFolder>
ConfigException
java.lang.InterruptedException
public AsyncRequestResult<CfgFolder> beginExecute(Action<AsyncRequestResult<CfgFolder>> callback, java.lang.Object state) throws ConfigException
callback
- The method to be called when query results are availablestate
- a user-defined object that qualifies or contains information about an asynchronous operation
ConfigException
public final void setDbid(int value)
value
- filter value on field "dbid".public final int getDbid()
setDbid(int)
public final void setName(java.lang.String value)
value
- filter value on field "name".public final java.lang.String getName()
setName(String)
public final void setOwnerDbid(int value)
owner_type
filter.
value
- filter value on field "owner_dbid".public final int getOwnerDbid()
owner_type
filter.
setOwnerDbid(int)
public final void setOwnerType(int value)
owner_dbid
filter.
value
- filter value on field "owner_type".public final int getOwnerType()
owner_dbid
filter.
setOwnerType(int)
public final void setType(int value)
value
- filter value on field "type".public final int getType()
setType(int)
public final void setDefaultFolder(int value)
owner_type
and owner_dbid
filters.
Most likely will be used with type
filter.
value
- filter value on field "default_folder".public final int getDefaultFolder()
owner_type
and owner_dbid
filters.
Most likely will be used with type
filter.
setDefaultFolder(int)
public final void setObjectDbid(int value)
object_type
filter.
value
- filter value on field "object_dbid".public final int getObjectDbid()
object_type
filter.
setObjectDbid(int)
public final void setObjectType(int value)
object_dbid
filter.
value
- filter value on field "object_type".public final int getObjectType()
object_dbid
filter.
setObjectType(int)
public final void setState(CfgObjectState value)
CfgObjectState
). If specified, Configuration Server
will return information only about folders that are currently in
this state.
value
- filter value on field "state".public final CfgObjectState getState()
CfgObjectState
). If specified, Configuration Server
will return information only about folders that are currently in
this state.
setState(CfgObjectState)
public final void setFolderClass(int value)
value
- filter value on field "folder_class".public final int getFolderClass()
setFolderClass(int)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |