|
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<CfgEnumerator>
com.genesyslab.platform.applicationblocks.com.queries.CfgEnumeratorQuery
public class CfgEnumeratorQuery
Class designed to construct queries to the Configuration Service for reading CfgEnumerator object(s).
ConfService
,
CfgEnumerator
Constructor Summary | |
---|---|
CfgEnumeratorQuery()
Create query object with default filter value for configuration objects of CfgEnumerator type. |
|
CfgEnumeratorQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgEnumerator type. |
|
CfgEnumeratorQuery(int dbid)
Create query object with filter initialized for the object DBID. |
|
CfgEnumeratorQuery(java.lang.String name)
Create query object with filter initialized for object name value. |
Method Summary | |
---|---|
AsyncRequestResult<CfgEnumerator> |
beginExecute(Action<AsyncRequestResult<CfgEnumerator>> callback,
java.lang.Object state)
Begins the asynchronous execution of the current query. |
java.util.Collection<CfgEnumerator> |
execute()
Executes the query and returns a list of CfgEnumerator objects. |
CfgEnumerator |
executeSingleResult()
Executes a query the result of which is a single object. |
int |
getDbid()
A unique identifier of an enumerator. |
java.lang.String |
getDisplayName()
Display name of an enumerator. |
int |
getEnumeratorType()
A unique identifier of an enumerator type. |
java.lang.String |
getName()
System name of an enumerator. |
CfgObjectState |
getState()
Current state of an enumerator (see
CfgObjectState
). |
int |
getTenantDbid()
A unique identifier of a tenant. |
void |
setDbid(int value)
A unique identifier of an enumerator. |
void |
setDisplayName(java.lang.String value)
Display name of an enumerator. |
void |
setEnumeratorType(int value)
A unique identifier of an enumerator type. |
void |
setName(java.lang.String value)
System name of an enumerator. |
void |
setState(CfgObjectState value)
Current state of an enumerator (see
CfgObjectState
). |
void |
setTenantDbid(int value)
A unique identifier of a 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 |
---|
public CfgEnumeratorQuery()
public CfgEnumeratorQuery(IConfService service)
service
- The configuration service to use when executing this querypublic CfgEnumeratorQuery(int dbid)
dbid
- value for filter on object dbidsetDbid(int)
public CfgEnumeratorQuery(java.lang.String name)
name
- value for filter on object namesetName(String)
Method Detail |
---|
public CfgEnumerator executeSingleResult() throws ConfigException
executeSingleResult
in class CfgQuery<CfgEnumerator>
ConfigException
public java.util.Collection<CfgEnumerator> execute() throws ConfigException, java.lang.InterruptedException
execute
in class CfgQuery<CfgEnumerator>
ConfigException
java.lang.InterruptedException
public AsyncRequestResult<CfgEnumerator> beginExecute(Action<AsyncRequestResult<CfgEnumerator>> 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 setTenantDbid(int value)
value
- filter value on field "tenant_dbid".public final int getTenantDbid()
setTenantDbid(int)
public final void setState(CfgObjectState value)
CfgObjectState
). If specified, Configuration Server
will return information only about enumerators 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 enumerators that are currently
in this state.
setState(CfgObjectState)
public final void setEnumeratorType(int value)
value
- filter value on field "enumerator_type".public final int getEnumeratorType()
setEnumeratorType(int)
public final void setDisplayName(java.lang.String value)
value
- filter value on field "display_name".public final java.lang.String getDisplayName()
setDisplayName(String)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |