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

public interface IReportParameterRangeValue

The IReportParameterRangeValue interface stores detailed information about the parameter value if it is a range value. For single values, see the IReportParameterSingleValue interface. Valuable information is also contained in the IReportParameterValue interface description.

See Also:

IReportParameterValue, IReportParameterSingleValue

Method Summary

IReportParameterSingleValue	getFromValue() Returns the lower bound of the range that restricts the scope of the value.
IReportParameterSingleValue	getToValue() Returns the upper limit of the range that restricts the scope of the parameter values.
boolean	isLowerBoundIncluded() Indicates that the value of the parameter can include the FromValue.
boolean	isLowerBoundNotAvailable() Indicates that the range, restricting the scope of the value, has no lower bound.
boolean	isNull() Returns whether the value is null.
boolean	isUpperBoundIncluded() Indicates that the value of the parameter can include the ToValue.
boolean	isUpperBoundNotAvailable() Indicates that the range, restricting the scope of the value, has no upper bound.
void	setLowerBoundIncluded(boolean bIncludesLowerBound) Sets whether the value of the parameter can include the FromValue.
void	setLowerBoundNotAvailable(boolean bHasNoLowerBound) Sets whether the range, restricting the scope of the value, has no lower bound.
void	setNull(boolean bIsNull) Sets whether the value is null.
void	setUpperBoundIncluded(boolean bIncludesUpperBound) Sets whether the value of the parameter can include the ToValue.
void	setUpperBoundNotAvailable(boolean bHasNoUpperBound) Sets whether the range, restricting the scope of the value, has no lower bound.

Method Detail

getFromValue

IReportParameterSingleValue getFromValue()

Returns the lower bound of the range that restricts the scope of the value.

Returns:

An IReportParameterSingleValue object specifying the lower bound of the range that restricts the scope of the value.

isLowerBoundNotAvailable

boolean isLowerBoundNotAvailable()

Indicates that the range, restricting the scope of the value, has no lower bound.

Returns:

true if the range has no lower bound, false otherwise.

setLowerBoundNotAvailable

void setLowerBoundNotAvailable(boolean bHasNoLowerBound)

Sets whether the range, restricting the scope of the value, has no lower bound.

Parameters:

bHasNoLowerBound - true if the range has no lower bound, false otherwise.

isUpperBoundNotAvailable

boolean isUpperBoundNotAvailable()

Indicates that the range, restricting the scope of the value, has no upper bound.

Returns:

true if the range has no lower bound, false otherwise.

setUpperBoundNotAvailable

void setUpperBoundNotAvailable(boolean bHasNoUpperBound)

Sets whether the range, restricting the scope of the value, has no lower bound.

Parameters:

bHasNoUpperBound - true if the range has no upper bound, false otherwise.

isLowerBoundIncluded

boolean isLowerBoundIncluded()

Indicates that the value of the parameter can include the FromValue.

Returns:

true if the range is inclusive of the lower bound, false otherwise.

setLowerBoundIncluded

void setLowerBoundIncluded(boolean bIncludesLowerBound)

Sets whether the value of the parameter can include the FromValue.

Parameters:

bIncludesLowerBound - true if the range is inclusive, false otherwise.

isUpperBoundIncluded

boolean isUpperBoundIncluded()

Indicates that the value of the parameter can include the ToValue.

Returns:

true if the range is inclusive of the upper bound, false otherwise.

setUpperBoundIncluded

void setUpperBoundIncluded(boolean bIncludesUpperBound)

Sets whether the value of the parameter can include the ToValue.

Parameters:

bIncludesUpperBound - true if the range is inclusive of the upper bound, false otherwise.

getToValue

IReportParameterSingleValue getToValue()

Returns the upper limit of the range that restricts the scope of the parameter values.

Returns:

An IReportParameterSingleValue specifying the upper limit of the range that restricts the scope of the parameter values.

isNull

boolean isNull()

Returns whether the value is null.

Returns:

true if the value is null, false otherwise.

setNull

void setNull(boolean bIsNull)

Sets whether the value is null.

Parameters:

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