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