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

All Known Subinterfaces:

IWDBoundValueSet.IWDFilterListener, IWDValueSupplier

public interface IWDValueSetSource

Base interface for IWDValueSupplier and IWDBoundValueSet.IWDFilterListener.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_progmodel/java/com/sap/tc/webdynpro/progmodel/api/IWDValueSetSource.java#1 $

Field Summary

static int	FILTER_ALL Constant used for indication of "filter supports key and values as argument".
static int	FILTER_KEY Constant used for indication of "filter supports only keys as argument".
static int	NO_FILTER_SUPPORT Constant used for indication of "no filter support".

Method Summary

boolean	contains(java.lang.Object key) Check if key is a valid key.
void	supplyLazyValues(java.util.Map keyValueMap, java.util.Locale locale) Implement this method in order to supply the values for a set of keys.
java.lang.String	supplyValue(java.lang.Object key, java.util.Locale locale) Implement this method in order to supply the value for a single key.
int	supportFilter() Check if this instance can process filtered value supply.
boolean	supportLazyValues() Check if this instance can process lazy value supply.

Field Detail

NO_FILTER_SUPPORT

public static final int NO_FILTER_SUPPORT

Constant used for indication of "no filter support". Used as return value for methode supportFilter

See Also:

supportFilter(), IWDValueSupplier.supplyFilteredValues(IModifiableSimpleValueSet, Locale, IWDValueFilter)

FILTER_KEY

public static final int FILTER_KEY

Constant used for indication of "filter supports only keys as argument". Used as return value for methode supportFilter

See Also:

supportFilter(), IWDValueSupplier.supplyFilteredValues(IModifiableSimpleValueSet, Locale, IWDValueFilter)

FILTER_ALL

public static final int FILTER_ALL

Constant used for indication of "filter supports key and values as argument". Used as return value for methode supportFilter

See Also:

supportFilter(), IWDValueSupplier.supplyFilteredValues(IModifiableSimpleValueSet, Locale, IWDValueFilter)

Method Detail

supplyValue

public java.lang.String supplyValue(java.lang.Object key,
                                    java.util.Locale locale)

Implement this method in order to supply the value for a single key.

Parameters:

key - is the key of the requested value.

locale - of the valueset's display text.

Returns:

the Value for the given key

supplyLazyValues

public void supplyLazyValues(java.util.Map keyValueMap,
                             java.util.Locale locale)

Implement this method in order to supply the values for a set of keys. It is legal to keep a reference to parameter keyValueSet until the components doPostProcessing method is called. The typical usage of this method is to store a reference to the keyValueSet and to fill the content later. The latest possible point in time for filling thwe map is doPostProcessing.

Parameters:

keyValueMap - is a map conatining a set of keys with empty values. The values have to be supplied

locale - of the valueset's display text.

Throws:

UnsupportedOperationException - in case this metod is not implemented. In this case method supportLazyValues must return false.

See Also:

supportLazyValues()

supportFilter

public int supportFilter()

Check if this instance can process filtered value supply.

Returns:

true, if method supplyFilteredValues is supported for this instance, else return false.

supportLazyValues

public boolean supportLazyValues()

Check if this instance can process lazy value supply. In case this instance does not support this feature any call to IWDOnDemandValueSetService.setCurrentKey(Object key) and IWDOnDemandValueSetService.addKey(Object Key) directly calls this instance's supplyValue(Object key, Locale locale) method

Returns:

the supported filter operation

See Also:

supplyValue(Object, Locale), IWDOnDemandValueSetService.addKey(Object), IWDOnDemandValueSetService.setCurrentKey(Object), IWDOnDemandValueSetService, supplyLazyValues(Map, Locale), NO_FILTER_SUPPORT, FILTER_KEY, FILTER_ALL

contains

public boolean contains(java.lang.Object key)

Check if key is a valid key. This method is called for validation purpose only. In case it is expensive to check the key, it is legal to return true for any key. In that case the key entered by the user is always valid in terms of framework validation and must be check somewhere else by application code.

Returns:

true if key is a valid key in this value set