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

All Superinterfaces:
IParameterFieldValue, IValue
All Known Implementing Classes:
ParameterFieldRangeValue

public interface IParameterFieldRangeValue
extends IParameterFieldValue

This interface is used to get and set values for a ranged parameter. The ParameterFieldRangeValue object stores the value for a ranged parameter. The object contains the upper bound, the lower bound range, and how the two are treated.


Method Summary
 java.lang.Object getBeginValue()
          Returns the lower-bound value of the range.
 java.lang.Object getEndValue()
          Returns the upper-bound value of the range.
 RangeValueBoundType getLowerBoundType()
           Returns how the lower bound of the range is treated.
 RangeValueBoundType getUpperBoundType()
           Returns how the upper bound of the range is treated.
 void setBeginValue(java.lang.Object beginValue)
          Sets the lower-bound value of the range.
 void setEndValue(java.lang.Object endValue)
          Returns the upper-bound value of the range.
 void setLowerBoundType(RangeValueBoundType lowerBoundType)
           Sets how the lower bound of the range is treated.
 void setUpperBoundType(RangeValueBoundType upperBoundType)
           Sets how the upper bound of the range is treated.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IParameterFieldValue
getDescription, setDescription
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IValue
computeText, displayText
 

Method Detail

getBeginValue

public java.lang.Object getBeginValue()

Returns the lower-bound value of the range. Use the getEndValue() method to determine the upper-bound value.

Returns:
The lower-bound value as an Object.

getEndValue

public java.lang.Object getEndValue()

Returns the upper-bound value of the range. Use the getBeginValue() method to determine the lower-bound value.

Returns:
The upper-bound value as an Object.

getLowerBoundType

public RangeValueBoundType getLowerBoundType()

Returns how the lower bound of the range is treated. Can also specify that the range has no lower bound.

Returns:
How the lower bound of the range is treated as a RangeValueBoundType Object.

getUpperBoundType

public RangeValueBoundType getUpperBoundType()

Returns how the upper bound of the range is treated. Can also specify that the range has no upper bound.

Returns:
How the upper bound of the range is treated as a RangeValueBoundType object.

setBeginValue

public void setBeginValue(java.lang.Object beginValue)

Sets the lower-bound value of the range. Use the getEndValue() method to determine the upper-bound value.

Parameters:
beginValue - The lower-bound value as an Object.

setEndValue

public void setEndValue(java.lang.Object endValue)

Returns the upper-bound value of the range. Use the getBeginValue() method to determine the lower-bound value.

Parameters:
endValue - The upper-bound value as an Object.

setLowerBoundType

public void setLowerBoundType(RangeValueBoundType lowerBoundType)

Sets how the lower bound of the range is treated. This method can also be used to specify that the range has no lower bound.

Parameters:
lowerBoundType - How the lower bound of the range is treated as a RangeValueBoundType Object.

setUpperBoundType

public void setUpperBoundType(RangeValueBoundType upperBoundType)

Sets how the upper bound of the range is treated. This method can also be used to specify that the range has no upper bound.

Parameters:
upperBoundType - How the upper bound of the range is treated as a RangeValueBoundType object.