com.crystaldecisions.sdk.plugin.desktop.common
Interface IReportParameterValue

All Known Subinterfaces:
IReportParameterSingleValue

public interface IReportParameterValue

The IReportParameterValue interface enables you to examine any one of the default or current values of a parameter. It contains basic information, such as the value of the parameter and whether it is a range or single value. The IReportParameterValue interface is used as a base class to support methods and properties that are common to both the IReportParameterRangeValue interface and IReportParameterSingleValue interface.

See Also:
IReportParameterRangeValue, IReportParameterSingleValue

Nested Class Summary
static interface IReportParameterValue.DateFormat
           This interface is used to specify the date parse format.
 
Method Summary
 ParameterFieldValue getParameterFieldValue(int valueType)
           Returns the equivalent ParameterFieldValue object.
 boolean isNull()
           Returns whether the value is null.
 java.lang.String makeDisplayString(java.util.Locale locale)
           Returns a string representation of the value.
 void setNull(boolean bIsNull)
           Sets whether the value is null.
 

Method Detail

isNull

public boolean isNull()

Returns whether the value is null.

Returns:
true if the value is null, false otherwise.

setNull

public void setNull(boolean bIsNull)

Sets whether the value is null.

Parameters:
bIsNull - true if the value is null, false otherwise.

makeDisplayString

public java.lang.String makeDisplayString(java.util.Locale locale)

Returns a string representation of the value.

Parameters:
locale - A Locale object specifying the localized display properties.
Returns:
A localized String representation of the value.

getParameterFieldValue

public ParameterFieldValue getParameterFieldValue(int valueType)

Returns the equivalent ParameterFieldValue object. The ParameterFieldValue object can then be used by the Crystal Reports Java Web Viewer.

Parameters:
valueType - An int specifying the value type.
Returns:
The equivalent ParameterFieldValue object, which can be used by the Crystal Reports Java Web Viewer
See Also:
IReportParameterRangeValue, IReportParameterSingleValue