|
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<TT>
public class CfgFilterBasedQuery<TT extends ICfgObject>
A general class that can hold arbitrary values of filter keys and values.
It contains a collection of
filter key-value pairs. If you have a need to work with multiple queries for objects, type of which
is not known in compile-time, use this class.
If you know the type of the objects, please, use more
specific Cfg***Query
classes.
Constructor Summary | |
---|---|
CfgFilterBasedQuery(CfgObjectType objType)
Creates a new instance of the class. |
|
CfgFilterBasedQuery(CfgObjectType objectType,
IConfService confService)
Deprecated. |
Method Summary | ||
---|---|---|
boolean |
equals(java.lang.Object obj)
|
|
|
getCfgObjectClass()
Deprecated. |
|
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.Class<TT> |
getQueryObjectClass()
|
|
java.lang.String |
getString(java.lang.String name)
Retrieves the value of the filter key-value pair as string value. |
|
int |
hashCode()
|
|
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. |
|
protected void |
setObjectClass(java.lang.Class<TT> clazz)
|
|
void |
setProperty(java.lang.String name,
java.lang.Object newValue)
Set the new value of the filter key-value pair. |
|
java.lang.String |
toString()
|
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgQuery |
---|
beginExecute, endExecute, execute, execute, executeSingleResult, 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 |
---|
@Deprecated public CfgFilterBasedQuery(CfgObjectType objectType, IConfService confService)
objectType
- type of object returned by this query.confService
- reference to IConfService to be used for query execution.public CfgFilterBasedQuery(CfgObjectType objType)
objType
- configuration server object type to read.Method Detail |
---|
protected void setObjectClass(java.lang.Class<TT> clazz)
public void setDoRequestObjectPath(boolean value)
ICfgFilterBasedQuery
true
, ConfService will add filter
parameter "object_path" to the read request.CfgObject.getObjectPath()
.
It is enabled by default.
setDoRequestObjectPath
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
value
- the object path request enabling flag value.CfgObject.getObjectPath()
public boolean getDoRequestObjectPath()
ICfgFilterBasedQuery
true
, ConfService will add filter
parameter "object_path" to the read request.CfgObject.getObjectPath()
.
getDoRequestObjectPath
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
CfgObject.getObjectPath()
public void setDoRequestFolderId(boolean value)
ICfgFilterBasedQuery
true
, ConfService will add filter
parameter "read_folder_dbid" to the read request.CfgObject.getFolderId()
.
It is enabled by default.
setDoRequestFolderId
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
value
- the folder DBID request enabling flag value.CfgObject.getFolderId()
public boolean getDoRequestFolderId()
ICfgFilterBasedQuery
true
, ConfService will add filter
parameter "read_folder_dbid" to the read request.CfgObject.getFolderId()
.
getDoRequestFolderId
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
CfgObject.getFolderId()
public void setProperty(java.lang.String name, java.lang.Object newValue)
setProperty
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
name
- Filter keynewValue
- New filter valuepublic java.lang.Object getProperty(java.lang.String name)
getProperty
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
name
- Filter key
public int getInt(java.lang.String name)
ICfgFilterBasedQuery
getInt
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
name
- Filter key
public java.lang.String getString(java.lang.String name)
ICfgFilterBasedQuery
getString
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
name
- Filter key
public CfgObjectType getCfgObjectType()
ICfgFilterBasedQuery
getCfgObjectType
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
@Deprecated public <T extends ICfgObject> java.lang.Class<T> getCfgObjectClass()
public java.lang.Class<TT> getQueryObjectClass()
getQueryObjectClass
in interface ICfgQueryObjectClass<TT extends ICfgObject>
public java.util.Hashtable<java.lang.String,java.lang.Object> getFilter()
ICfgFilterBasedQuery
getFilter
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
ICfgFilterBasedQuery.getExtraFilter()
public java.util.Hashtable<java.lang.String,java.lang.Object> getExtraFilter()
ICfgFilterBasedQuery
getExtraFilter
in interface ICfgFilterBasedQuery<TT extends ICfgObject>
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |