|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.filter.QueryFilter
This object implements a general purpose map of parameters to be used in calls to TWS API methods that return multiple results. For each parameter, the corresponding value can be edited and queried through setFilter() and getFilter() methods, while all parameter names included in a QueryFilter object can be browsed through the getNames() method.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
QueryFilter()
Creates an empty QueryFilter. |
Method Summary | |
---|---|
boolean |
containsFilter(java.lang.String name)
Returns true if the specified parameter is contained in this QueryFilter. |
java.lang.Object |
getFilter(java.lang.String name)
Returns the value stored in this QueryFilter for the specified parameter. |
java.util.Iterator |
getNames()
Allows iterating over all parameters stored in this QueryFilter. |
void |
resetFilter(java.lang.String name)
Removes the specified parameter from this QueryFilter. |
void |
setFilter(java.lang.String name,
java.lang.Object value)
Stores in this QueryFilter a new value for the specified parameter. |
java.lang.String |
toString()
Returns a string representation of this QueryFilter object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public QueryFilter()
Method Detail |
public java.lang.Object getFilter(java.lang.String name)
name
- The name of a filter parameter.
public void setFilter(java.lang.String name, java.lang.Object value)
name
- The name of a filter parameter.value
- The value to be stored in this QueryFilter for the specified parameter (null is allowed).public void resetFilter(java.lang.String name)
name
- The name of a filter parameter.public boolean containsFilter(java.lang.String name)
name
- The name of a filter parameter.
public java.util.Iterator getNames()
public java.lang.String toString()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |