com.ibm.tws.objects.filter
Class QueryFilter

java.lang.Object
  extended bycom.ibm.tws.objects.filter.QueryFilter
All Implemented Interfaces:
java.io.Serializable

public class QueryFilter
extends java.lang.Object
implements java.io.Serializable

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.

See Also:
Serialized Form

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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

QueryFilter

public QueryFilter()
Creates an empty QueryFilter.

Method Detail

getFilter

public java.lang.Object getFilter(java.lang.String name)
Returns the value stored in this QueryFilter for the specified parameter.

Parameters:
name - The name of a filter parameter.
Returns:
The value currently stored in this QueryFilter for the specified parameter (if null, value is null or missing).

setFilter

public void setFilter(java.lang.String name,
                      java.lang.Object value)
Stores in this QueryFilter a new value for the specified parameter.

Parameters:
name - The name of a filter parameter.
value - The value to be stored in this QueryFilter for the specified parameter (null is allowed).

resetFilter

public void resetFilter(java.lang.String name)
Removes the specified parameter from this QueryFilter.

Parameters:
name - The name of a filter parameter.

containsFilter

public boolean containsFilter(java.lang.String name)
Returns true if the specified parameter is contained in this QueryFilter.

Parameters:
name - The name of a filter parameter.
Returns:
True if the specified parameter is contained in this QueryFilter.

getNames

public java.util.Iterator getNames()
Allows iterating over all parameters stored in this QueryFilter.

Returns:
An iterator of the names of all parameters stored in this QueryFilter.

toString

public java.lang.String toString()
Returns a string representation of this QueryFilter object.

Returns:
A text string including all parameters stored in this QueryFilter.


Copyright © 2005 IBM All Rights Reserved.