com.sas.dataselectors.filters
Interface FilterValuesInterface

All Known Implementing Classes:

AdvancedFilterValueList, DefaultFilterValueList, OLAPLevelMemberTreeModel, OLAPMemberDeferredRetrievalTreeNode, OLAPMemberTreeModel, OLAPMemberValueAndTreeModel

public interface FilterValuesInterface

This defines a interface to retrieve values for a given item. The toString() value for these objects is displayed to the user but the actual object itself is stored in the FilterLogic result.

Field Summary

static long

GETTHRESHHOLDALLVALUES

Method Summary

java.util.List	getFirstValues(long lThreshold) Returns the first group in a list of objects for an Item.
java.lang.String	getListLabel() Returns the current label for this list of values.
java.util.List	getNextValues(long lThreshold) Returns the next group in a list of objects for an Item.
boolean	hasMoreValues() Returns TRUE as long as there remain values to be retrieved from the datasource.

Field Detail

GETTHRESHHOLDALLVALUES

static final long GETTHRESHHOLDALLVALUES

See Also:

Constant Field Values

Method Detail

getFirstValues

java.util.List getFirstValues(long lThreshold)
                              throws DataRetrievalError

Returns the first group in a list of objects for an Item. The toString() of these objects will be displayed to the user and the actual object will be returned as part of the selected filter data. If a threshold of 0 is used then all values should be returned. (see ValuesInterface::GETTHRESHHOLDALLVALUES)

Parameters:

lThreshold -

Returns:

List (of Object)

Throws:

DataRetrievalError - if an error prevented returning any values

getNextValues

java.util.List getNextValues(long lThreshold)
                             throws DataRetrievalError

Returns the next group in a list of objects for an Item. If a threshold of 0 is used then all the remaining values should be returned.

Parameters:

lThreshold -

Returns:

List (of Object)

Throws:

DataRetrievalError - if an error prevented returning any values

hasMoreValues

boolean hasMoreValues()

Returns TRUE as long as there remain values to be retrieved from the datasource.

Returns:

boolean

getListLabel

java.lang.String getListLabel()

Returns the current label for this list of values.