com.businessobjects.rebean.wi
Interface Values

All Known Subinterfaces:
CustomSortValues

public interface Values

The Values interface represents a set of values in a List Of Values.

An object of this type is returned when you get the values of a list of values (Lov). If search mode is enabled in Lov, the content of the Values object can be filtered.

The size of the Values object to be returned by Lov.getValues is determined by setting Lov.BatchSize. For example, for a Lov has one hundred rows, If Lov.setBatchSize is set to 10, a subsequent call of Lov.getValues( 3 ) will return a Values object containing rows 30 to 39 from the List Of Values.
Calling Lov.getAllValues will retrieve a Values object containing all rows of data in the Lov.

If the values are multi-columned each value in the set is represented by the RowValue interface.

See Also:
Lov.getValues(int), Lov.isSearchActive()

Method Summary
 int getCount()
          Gets the number of values.
 int getIndex()
          Gets the index of this chunk.
 java.lang.String getName()
          Returns the name of this batch of List Of Values data.
 RowValue getRowValue(int index)
          Gets a row of values.
 java.lang.String getValue(int index)
          Returns the value at row.
 ValueFromLov getValueFromLov(int index)
          Returns the ValueFromLov at position index.
 boolean isDefault(int index)
          Tests if a value is a default value.
 boolean isFirst()
          Returns true if this Values object is the first in a List Of Values object.
 boolean isLast()
          Returns true if this Values object is the first in a List Of Values object.
 boolean isMultiColumns()
          Tests if this set of values is multi-columned.
 boolean isSelected(int index)
          Tests if a value is currently selected.
 boolean wasSelected(int index)
          Tests if a value was selected.
 

Method Detail

isMultiColumns

boolean isMultiColumns()
Tests if this set of values is multi-columned.

If the set of values is multi-columned, use RowValue.getRowValue access the columns and their values. Otherwise Use RowValue.getValue to get the value as a String.

Returns:
true if there is more than one column; False otherwise

getIndex

int getIndex()
Gets the index of this chunk.

Returns:
the current chunk index

getName

java.lang.String getName()
Returns the name of this batch of List Of Values data.

Returns:
the name of this chunk

getCount

int getCount()
Gets the number of values.

Returns:
the number of values in the set

getValue

java.lang.String getValue(int index)
                          throws java.lang.IndexOutOfBoundsException
Returns the value at row.

Parameters:
index - the position of the value in the collection
Returns:
the value at the specified position in the collection
Throws:
java.lang.IndexOutOfBoundsException - if index is less than 0 or greater than Values.getCount.
See Also:
Values.getCount()

getRowValue

RowValue getRowValue(int index)
Gets a row of values.

To use this method, the Values in the collection must be multi-columned. Use Values.isMultiColumn to check if the values in the collection is multi-columned. If the Values are not multi-columned, use Values.getValue to return the Value. This method returns null if it is called when isMultiColumn is false.

Returns:
a row value
See Also:
Values.isMultiColumns(), Values.getValue(int)

isFirst

boolean isFirst()
Returns true if this Values object is the first in a List Of Values object.

Returns:
true if this is the first batch of a List Of Values.

isLast

boolean isLast()
Returns true if this Values object is the first in a List Of Values object.

Returns:
true if this is the last batch of a List Of Values.

isDefault

boolean isDefault(int index)
Tests if a value is a default value.

Returns:
true if this is a default value for the List Of Values; false otherwise
See Also:
Prompt.getDefaultValues()

isSelected

boolean isSelected(int index)
Tests if a value is currently selected.

Returns:
true if this value is selected; false otherwise
See Also:
Prompt.getCurrentValues()

wasSelected

boolean wasSelected(int index)
Tests if a value was selected.

Returns:
true if this value has been selected; false otherwise
See Also:
Prompt.getPreviousValues()

getValueFromLov

ValueFromLov getValueFromLov(int index)
Returns the ValueFromLov at position index. If the object at position index is not a valid ValueFromLov object, null is returned.

Parameters:
index - The position of the value in the collection.
Returns:
The ValueFromLov object.
Since:
11.5