com.crystaldecisions.sdk.occa.report.data
Interface IFieldRangeFilterItem

All Superinterfaces:
IClone, IFilterItem
All Known Implementing Classes:
FieldRangeFilterItem

public interface IFieldRangeFilterItem
extends IFilterItem

This interface is used to represent a primitive expression in a filter string. A primitive expression is an expression that contains a field, an operator, and another field or value.


Method Summary
 boolean getInclusive()
          Returns whether, if the operator compares a range, the compared value is included in the comparison.
 SelectionOperation getOperation()
          Returns the type of operation being performed on the field that is being used as a filter.
 IField getRangeField()
          Returns the range field that represents the field that is being used in the operation.
 Values getValues()
          Returns the values that are being compared with those in the range field.
 void setInclusive(boolean inclusive)
          Sets whether, if the operator compares a range, the compared value is included in the comparison.
 void setOperation(SelectionOperation operation)
          Sets the type of operation being performed on the field that is being used as a filter.
 void setRangeField(IField rangeField)
          Sets the range field that represents the field that is being used in the operation.
 void setValues(Values values)
          Sets the values that are being compared with those in the range field.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IFilterItem
computeText, displayText
 

Method Detail

getInclusive

boolean getInclusive()

Returns whether, if the operator compares a range, the compared value is included in the comparison. If, for example, the "greater than" operator is used, if Inclusive is True, then the operator will effectively be "greater than or equal to".

Returns:
true if the value is included in the comparison, and false otherwise.

getOperation

SelectionOperation getOperation()

Returns the type of operation being performed on the field that is being used as a filter.

Returns:
The SelectionOperation object.

getRangeField

IField getRangeField()

Returns the range field that represents the field that is being used in the operation. The range field is the field that is being used in the filter to determine the result of the expression.

Returns:
The range field as an IField.

getValues

Values getValues()

Returns the values that are being compared with those in the range field. There are two different types of values that are stored: constant values, which represent a literal value, and expression values, which are values that require evaluation.

Returns:
The values as a Values object.

setInclusive

void setInclusive(boolean inclusive)

Sets whether, if the operator compares a range, the compared value is included in the comparison. If, for example, the "greater than" operator is used, if Inclusive is True, then the operator will effectively be "greater than or equal to".

Parameters:
inclusive - true if the value is included in the comparison, and false otherwise.

setOperation

void setOperation(SelectionOperation operation)

Sets the type of operation being performed on the field that is being used as a filter.

Parameters:
operation - The SelectionOperation object.

setRangeField

void setRangeField(IField rangeField)

Sets the range field that represents the field that is being used in the operation. The range field is the field that is being used in the filter to determine the result of the expression.

Parameters:
rangeField - The range field as an IField.

setValues

void setValues(Values values)

Sets the values that are being compared with those in the range field. There are two different types of values that are stored: constant values, which represent a literal value, and expression values, which are values that require evaluation.

Parameters:
values - The values as a Values object.