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

All Superinterfaces:

com.sap.typeservices.ISimpleValueServices

All Known Subinterfaces:

IWDBoundValueSet

public interface IWDOnDemandValueSetService

extends com.sap.typeservices.ISimpleValueServices

Interface for providing a loadable valueset on demand

Method Summary

void	addKey(java.lang.Object key) Add a key to the current valueset.
void	addKeyValuePair(java.lang.Object key, java.lang.String value) Add a key value pair to the current valueset.
void	invalidate() Invalidate valueset, needs to to requested next time value help is needed.
void	resetCurrentKeys() reset the temporary valueset for display.
void	setCurrentKey(java.lang.Object key) Sets the current valueset to a single key containing this key.
void	setCurrentKeyValuePair(java.lang.Object key, java.lang.String value) Sets the current valueset to a single entry containing this key Value Pair for display of the current key.

Methods inherited from interface com.sap.typeservices.ISimpleValueServices

getLocale, getModifiableSimpleValueSet, getValues, getValues, validate, validate

Method Detail

invalidate

public void invalidate()

Invalidate valueset, needs to to requested next time value help is needed.

setCurrentKeyValuePair

public void setCurrentKeyValuePair(java.lang.Object key,
                                   java.lang.String value)

Sets the current valueset to a single entry containing this key Value Pair for display of the current key. It is up to the application developer to set the proper key - value pair according to the context attributes current value.

Parameters:

key - is the key for this value pair

value - is the human readable value

setCurrentKey

public void setCurrentKey(java.lang.Object key)

Sets the current valueset to a single key containing this key. It is up to the application developer to set the proper key to the context attributes current value. The value is requested internally by calling IWDValueSupplier.getValue(Object key).

Parameters:

key - is the key for this value pair

addKeyValuePair

public void addKeyValuePair(java.lang.Object key,
                            java.lang.String value)

Add a key value pair to the current valueset. The current value set is a reduced valueset containing only the key value pair needed for display. Several key value pairs may be needed for table display. For single record display usually only one key value pair is needed.

Parameters:

key - is the key for this value pair

value - is the human readable value

addKey

public void addKey(java.lang.Object key)

Add a key to the current valueset. The current value set is a reduced valueset containing only the key value pair needed for display. Several key value pairs may be needed for table display. For single record display usually only one key value pair is needed. The value is requested internally by calling IWDValueSupplier.getValue(Object key).

Parameters:

key - is the key for this value pair

resetCurrentKeys

public void resetCurrentKeys()

reset the temporary valueset for display.