|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICfgFilterBasedQuery<TT extends ICfgObject>
Each filter-based query object should implement this general interface.
Method Summary | |
---|---|
CfgObjectType |
getCfgObjectType()
The Configuration Server object type that the query corresponds to. |
boolean |
getDoRequestFolderId()
Gets filter option for notification of configuration server about need of the folder DBID information to be sent with the main objects data. |
boolean |
getDoRequestObjectPath()
Gets filter option for notification of configuration server about need of the object path information to be collected and sent with the main objects data. |
java.util.Hashtable<java.lang.String,java.lang.Object> |
getExtraFilter()
Returns additional request filter properties for server object(s) read request. |
java.util.Hashtable<java.lang.String,java.lang.Object> |
getFilter()
Returns map with filter properties set. |
int |
getInt(java.lang.String name)
Retrieves the value of the filter key-value pair as integer value. |
java.lang.Object |
getProperty(java.lang.String name)
Retrieves the value of the filter key-value pair. |
java.lang.String |
getString(java.lang.String name)
Retrieves the value of the filter key-value pair as string value. |
void |
setDoRequestFolderId(boolean value)
Sets filter option for notification of configuration server about need of the folder DBID information to be sent with the main objects data. |
void |
setDoRequestObjectPath(boolean value)
Sets filter option for notification of configuration server about need of the object path information to be collected and sent with the main objects data. |
void |
setProperty(java.lang.String name,
java.lang.Object newValue)
Set the new value of the filter key-value pair. |
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgQuery |
---|
beginExecute, endExecute, execute, executeSingleResult |
Method Detail |
---|
void setProperty(java.lang.String name, java.lang.Object newValue)
name
- Filter keynewValue
- New filter valuejava.lang.Object getProperty(java.lang.String name)
name
- Filter key
int getInt(java.lang.String name)
name
- Filter key
java.lang.String getString(java.lang.String name)
name
- Filter key
CfgObjectType getCfgObjectType()
java.util.Hashtable<java.lang.String,java.lang.Object> getFilter()
getExtraFilter()
java.util.Hashtable<java.lang.String,java.lang.Object> getExtraFilter()
void setDoRequestObjectPath(boolean value)
true
, ConfService will add filter
parameter "object_path" to the read request.CfgObject.getObjectPath()
.
It is enabled by default.
value
- the object path request enabling flag value.CfgObject.getObjectPath()
boolean getDoRequestObjectPath()
true
, ConfService will add filter
parameter "object_path" to the read request.CfgObject.getObjectPath()
.
CfgObject.getObjectPath()
void setDoRequestFolderId(boolean value)
true
, ConfService will add filter
parameter "read_folder_dbid" to the read request.CfgObject.getFolderId()
.
It is enabled by default.
value
- the folder DBID request enabling flag value.CfgObject.getFolderId()
boolean getDoRequestFolderId()
true
, ConfService will add filter
parameter "read_folder_dbid" to the read request.CfgObject.getFolderId()
.
value
- the folder DBID request enabling flag value.CfgObject.getFolderId()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |