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