com.sap.tc.webdynpro.progmodel.api
Interface IWDValueSupplier

All Superinterfaces:

IWDValueSetSource

All Known Implementing Classes:

WDSimpleValueSupplier

public interface IWDValueSupplier

extends IWDValueSetSource

Interface for dynamic reload of valuesets on demand.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDValueSetSource

FILTER_ALL, FILTER_KEY, NO_FILTER_SUPPORT

Method Summary

void	supplyFilteredValues(com.sap.typeservices.IModifiableSimpleValueSet initialSet, java.util.Locale locale, IWDValueFilter Filter) Implement this method in order to supply the necessary valueset on demand.
boolean	supplyValues(com.sap.typeservices.IModifiableSimpleValueSet initialSet, java.util.Locale locale) Implement this method in order to supply the necessary valueset on demand.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDValueSetSource

contains, supplyLazyValues, supplyValue, supportFilter, supportLazyValues

Method Detail

supplyValues

public boolean supplyValues(com.sap.typeservices.IModifiableSimpleValueSet initialSet,
                            java.util.Locale locale)

Implement this method in order to supply the necessary valueset on demand.

Parameters:

initialSet - is an empty valueset to be filled by this method.

locale - of the valueset's display text.

Returns:

true, if valueset should be loaded on demand only once and keeps stable afterwards, returns false if valueset should be reloaded again when the user clicks the "request valueset button"

supplyFilteredValues

public void supplyFilteredValues(com.sap.typeservices.IModifiableSimpleValueSet initialSet,
                                 java.util.Locale locale,
                                 IWDValueFilter Filter)

Implement this method in order to supply the necessary valueset on demand.

Parameters:

initialSet - is an empty valueset to be filled by this method.

locale - of the valueset's display text.

Filter - are the current filter values entered by the use.

Throws:

UnsupportedOperationException - in case the method cannot be implmented. In this case base interface method @link IWDValueSetSource#supportFilter() must return false!