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