com.sap.tc.webdynpro.progmodel.api
Class WDSimpleValueSupplier

java.lang.Object
  |
  +--com.sap.tc.webdynpro.progmodel.api.WDSimpleValueSupplier

All Implemented Interfaces:

IWDValueSetSource, IWDValueSupplier

public abstract class WDSimpleValueSupplier

extends java.lang.Object

implements IWDValueSupplier

Default implementation of IWDValueSupplier. The default implementation assumes that only the valueset has to be retrieved. All other features of on demand loadable valuesets are implemented here.

The following methods must be implemented in any derived class:

• public boolean IWDValueSupplier.supplyValues(IModifiableSimpleValueSet initialSet, Locale locale)
• public String IWDValueSetSource.supplyValue(Object key, Locale locale)
• public boolean IWDValueSetSource.contains(Object key)

See Also:

IWDValueSupplier

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

FILTER_ALL, FILTER_KEY, NO_FILTER_SUPPORT

Constructor Summary

WDSimpleValueSupplier()

Method Summary

abstract boolean	contains(java.lang.Object key) Check if key is a valid key.
void	supplyFilteredValues(com.sap.typeservices.IModifiableSimpleValueSet initialSet, java.util.Locale locale, IWDValueFilter Filter) Overwrite this method in order get filtered value help.
void	supplyLazyValues(java.util.Map keyValueMap, java.util.Locale locale) Overwrite this method in order get lazy key to value resolution in doPostProcessing
abstract 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.
abstract boolean	supplyValues(com.sap.typeservices.IModifiableSimpleValueSet initialSet, java.util.Locale locale) Implement this method in order to supply the necessary valueset on demand.
int	supportFilter() Overwrite this method in order get filtered value help.
boolean	supportLazyValues() Overwrite this method in order get lazy key to value resolution in doPostProcessing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WDSimpleValueSupplier

public WDSimpleValueSupplier()

Method Detail

supplyValues

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

Description copied from interface: IWDValueSupplier

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

Specified by:

supplyValues in interface IWDValueSupplier

See Also:

IWDValueSupplier.supplyValues(com.sap.typeservices.IModifiableSimpleValueSet, java.util.Locale)

supplyValue

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

Description copied from interface: IWDValueSetSource

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

Specified by:

supplyValue in interface IWDValueSetSource

See Also:

IWDValueSetSource.supplyValue(java.lang.Object, java.util.Locale)

contains

public abstract boolean contains(java.lang.Object key)

Description copied from interface: IWDValueSetSource

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.

Specified by:

contains in interface IWDValueSetSource

See Also:

IWDValueSetSource.contains(java.lang.Object)

supplyFilteredValues

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

Overwrite this method in order get filtered value help. This is recommended for large valueset

Specified by:

supplyFilteredValues in interface IWDValueSupplier

See Also:

IWDValueSupplier.supplyFilteredValues(com.sap.typeservices.IModifiableSimpleValueSet, java.util.Locale, com.sap.tc.webdynpro.progmodel.api.IWDValueFilter)

supplyLazyValues

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

Overwrite this method in order get lazy key to value resolution in doPostProcessing

Specified by:

supplyLazyValues in interface IWDValueSetSource

See Also:

IWDValueSetSource.supplyLazyValues(java.util.Map, java.util.Locale)

supportFilter

public int supportFilter()

Overwrite this method in order get filtered value help. This is recommended for large valueset

Specified by:

supportFilter in interface IWDValueSetSource

See Also:

IWDValueSetSource.supportFilter()

supportLazyValues

public boolean supportLazyValues()

Overwrite this method in order get lazy key to value resolution in doPostProcessing

Specified by:

supportLazyValues in interface IWDValueSetSource

See Also:

IWDValueSetSource.supportLazyValues()