com.ibm.team.fvt.tests.clm.pages.rm.filter
Class RmAttributeFilterCriteria

java.lang.Object
  extended by com.ibm.team.fvt.tests.clm.pages.rm.filter.RmAttributeFilterCriteria

public class RmAttributeFilterCriteria
extends java.lang.Object

Manages the setting of the criteria of an attribute filter.

It currently provides basic support for the following attribute filters: Name, Artifact Type, Modified by, and Where Used. Also, it supports applying one attribute filter at a time; it presently does not support combining multiple attribute filters.


Field Summary
static java.lang.String ARTIFACT_TYPE_FILTER
           
static java.lang.String CONTAINS_OPERATOR
          Constants for operators.
static java.lang.String DOES_NOT_CONTAIN_OPERATOR
           
static java.lang.String ENDS_WITH_OPERATOR
           
static java.lang.String IS_ALL_OF_OPERATOR
           
static java.lang.String IS_ANY_OF_OPERATOR
           
static java.lang.String IS_NOT_All_OF_OPERATOR
           
static java.lang.String IS_NOT_ANY_OF_OPERATOR
           
static java.lang.String MODIFIED_BY_FILTER
           
static java.lang.String NAME_FILTER
          Constants for supported attribute type filters.
static java.lang.String STARTS_WITH_OPERATOR
           
static java.lang.String WHERE_USED_FILTER
           
 
Constructor Summary
RmAttributeFilterCriteria(java.lang.String attribute)
           
 
Method Summary
 java.lang.String getAttribute()
          Gets the name of the attribute filter that the criteria pertains to.
 java.lang.String getOperator()
          Gets the operator specified in the criteria
 java.lang.String getSearchFor()
          Gets the search for text specified in the criteria
 java.lang.String getValue()
          Gets the value specified in the criteria
 java.util.List<java.lang.String> getValues()
          Gets the list of values specified in the criteria
 void setOperator(java.lang.String operator)
          Sets the operator in the criteria
 void setSearchFor(java.lang.String searchFor)
          Sets the search for text in the criteria which will be used to filter the list of possible values to select.
 void setValue(java.lang.String value)
          Sets the value in the criteria
 void setValueList(java.util.List<java.lang.String> values)
          Sets the multi-value list in the criteria
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME_FILTER

public static final java.lang.String NAME_FILTER
Constants for supported attribute type filters.

See Also:
Constant Field Values

ARTIFACT_TYPE_FILTER

public static final java.lang.String ARTIFACT_TYPE_FILTER
See Also:
Constant Field Values

MODIFIED_BY_FILTER

public static final java.lang.String MODIFIED_BY_FILTER
See Also:
Constant Field Values

WHERE_USED_FILTER

public static final java.lang.String WHERE_USED_FILTER
See Also:
Constant Field Values

CONTAINS_OPERATOR

public static final java.lang.String CONTAINS_OPERATOR
Constants for operators.

See Also:
Constant Field Values

DOES_NOT_CONTAIN_OPERATOR

public static final java.lang.String DOES_NOT_CONTAIN_OPERATOR
See Also:
Constant Field Values

STARTS_WITH_OPERATOR

public static final java.lang.String STARTS_WITH_OPERATOR
See Also:
Constant Field Values

ENDS_WITH_OPERATOR

public static final java.lang.String ENDS_WITH_OPERATOR
See Also:
Constant Field Values

IS_ANY_OF_OPERATOR

public static final java.lang.String IS_ANY_OF_OPERATOR
See Also:
Constant Field Values

IS_NOT_ANY_OF_OPERATOR

public static final java.lang.String IS_NOT_ANY_OF_OPERATOR
See Also:
Constant Field Values

IS_ALL_OF_OPERATOR

public static final java.lang.String IS_ALL_OF_OPERATOR
See Also:
Constant Field Values

IS_NOT_All_OF_OPERATOR

public static final java.lang.String IS_NOT_All_OF_OPERATOR
See Also:
Constant Field Values
Constructor Detail

RmAttributeFilterCriteria

public RmAttributeFilterCriteria(java.lang.String attribute)
Method Detail

getAttribute

public java.lang.String getAttribute()
Gets the name of the attribute filter that the criteria pertains to.

Returns:
a String containing the name of the attribute

getOperator

public java.lang.String getOperator()
Gets the operator specified in the criteria

Returns:
a String representing the operator

getSearchFor

public java.lang.String getSearchFor()
Gets the search for text specified in the criteria

Returns:
a String representing the search for text

getValue

public java.lang.String getValue()
Gets the value specified in the criteria

Returns:
a String representing the value

getValues

public java.util.List<java.lang.String> getValues()
Gets the list of values specified in the criteria

Returns:
a List of String representing the values

setOperator

public void setOperator(java.lang.String operator)
Sets the operator in the criteria

Parameters:
operator - The operator to set.

setSearchFor

public void setSearchFor(java.lang.String searchFor)
Sets the search for text in the criteria which will be used to filter the list of possible values to select.

Not this is only applicable to attribute filters that allow multiple values to be selected.

Parameters:
searchFor - The search for text to set

setValue

public void setValue(java.lang.String value)
Sets the value in the criteria

Note this is only applicable to attribute filters that expect a single value.

Parameters:
value - The value to set

setValueList

public void setValueList(java.util.List<java.lang.String> values)
Sets the multi-value list in the criteria

Note this is only applicable to attribute filters that allow a multi-value list.

Parameters:
values - The list of string values to set