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

All Superinterfaces:
IClone
All Known Subinterfaces:
IFieldRangeFilterItem, IOperatorFilterItem
All Known Implementing Classes:
FieldRangeFilterItem, FilterItem, OperatorFilterItem

public interface IFilterItem
extends IClone

Interface for the FilterItem object.


Method Summary
 java.lang.String computeText()
           Returns a String representation of the field value that can be used in a report formula.
 java.lang.String displayText(FieldDisplayNameType displayNameType, java.util.Locale locale)
           Returns the field's value as a localized and formatted string.
 

Method Detail

computeText

java.lang.String computeText()

Returns a String representation of the field value that can be used in a report formula. The string is not formatted or localized. The syntax will always be Crystal syntax.

If the field contains a date, computeText returns Date(x, x, x); if it contains a date and time, computeText returns DateTime(x, x, x, x, x, x). However, when the date is 1900, 0, 1 (the Java start date), computeText returns Time(x, x, x). If you want to set a field to a time value only (that is, with no date), you should set the date to 1900, 0, 1, so that computeText will retrieve the correct information.

Returns:
A String representation of the field value that can be used in a report formula.

displayText

java.lang.String displayText(FieldDisplayNameType displayNameType,
                             java.util.Locale locale)

Returns the field's value as a localized and formatted string.

Parameters:
displayNameType - How the field names in the filter should be formatted.
locale - The locale that is used to format the string. If this value is not specified and you are writing a Win32 application, the locale will be the user's default locale. If you are writing a thin client (a script that is running on a server) and this value is not specified, the server's default locale will be used.
Returns:
The field's value as a localized and formatted string.