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

All Superinterfaces:
java.util.Collection, java.util.List

public interface IReportParameterValues
extends java.util.List

The IReportParameterValues interface returns a collection of IReportParameterValue objects that represent the value, or values, for a specified parameter. It allows you to examine each parameter value in the collection, as well as to add and remove values.

Note that while it is specified that the collection contains a List of IReportParameterValue objects, this is actually a super-class of the IReportParameterRangeValue and IReportParameterSingleValue interfaces, and is thus, an abstract class. When you access an item in the collection, you will actually retrieve one of the two sub-classes. These classes have the isSingleValue and isRangeValue methods to identify themselves. IReportParameterValues is owned by the IReportParameter object.


Method Summary
 IReportParameterRangeValue addRangeValue()
           Adds an empty range value to the end of the list.
 IReportParameterSingleValue addSingleValue()
           Adds an empty single value to the end of the list.
 Values getValues(int valueType)
           Returns the equivalent Values collection.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

addSingleValue

public IReportParameterSingleValue addSingleValue()

Adds an empty single value to the end of the list.

Returns:
The newly added empty IReportParameterSingleValue object.

addRangeValue

public IReportParameterRangeValue addRangeValue()

Adds an empty range value to the end of the list.

Returns:
The newly added empty IReportParameterRangeValue object.

getValues

public Values getValues(int valueType)

Returns the equivalent Values collection. This method allows the conversion of a ReportParameterValues collection to a collection that can be used by the Crystal Reports Java Web Viewer.

Parameters:
valueType - An int specifying the value type.
Returns:
The equivalent Values collection object, which can be used by the Crystal Reports Java Web Viewer.