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

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

public class WDValueServices

extends java.lang.Object

Helper class to create some special value sets.

Version:

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

See Also:

IWDOnDemandValueSetService, IWDBoundValueSet

Inner Class Summary

static interface

WDValueServices.IWDValueServices Interface to the framework class doing the work.

Constructor Summary

WDValueServices()

Method Summary

static void	addOVSExtension(java.lang.String providerName, IWDAttributeInfo[] startupAttributes, com.sap.tc.cmi.model.ICMIQuery cmiQuery, IWDOVSNotificationListener queryListener) adds ovs extension to a valuenode/modelnode
static void	addOVSExtension(java.lang.String providerName, IWDAttributeInfo[] startupAttributes, IWDNode queryInputNode, IWDNode queryResultNode, IWDOVSContextNotificationListener queryListener) adds ovs functionalities for the specified attributes.
static IWDBoundValueSet	createBoundValueSet(IWDAttributeInfo attrInfoSelectedKey, IWDNode dataSource, IWDAttributeInfo attrInfoKey, IWDAttributeInfo attrInfoValue) Create an IWDBoundValueSet.
static IWDBoundValueSet	createBoundValueSet(IWDAttributeInfo attrInfoSelectedKey, IWDNode dataSource, IWDAttributeInfo attrInfoKey, IWDAttributeInfo attrInfoValue, IWDBoundValueSet.IWDFilterListener selection) Create an IWDBoundValueSet.
static IWDOnDemandValueSetService	createOnDemandValueSet(IWDValueSupplier theSupplier, IWDAttributeInfo attrInfo) Create an instance of IWDOnDemandValueSetService for context attributes using attrInfo as metadata.
static void	removeOVSExtension(java.lang.String providerName, IWDAttributeInfo[] startupAttributes) removes the ovs extension from the specified attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

WDValueServices

public WDValueServices()

Method Detail

createOnDemandValueSet

public static IWDOnDemandValueSetService createOnDemandValueSet(IWDValueSupplier theSupplier,
                                                                IWDAttributeInfo attrInfo)

Create an instance of IWDOnDemandValueSetService for context attributes using attrInfo as metadata. theSupplier is a reference to an application provided interface. This implementation is in charge of retrieving the valueset on demand. There is no guarantee about the time the supplying methods of this interface are called. It is up to the framework to call at any time.

IMPORTANT NOTE: This class creates a modifiable type for attrInfo

Parameters:

theSupplier - is a reference to the supplying applcation code filling the valueset on demand

attrInfo - is the context attribute using this valueset on demand

createBoundValueSet

public static IWDBoundValueSet createBoundValueSet(IWDAttributeInfo attrInfoSelectedKey,
                                                   IWDNode dataSource,
                                                   IWDAttributeInfo attrInfoKey,
                                                   IWDAttributeInfo attrInfoValue)

Create an IWDBoundValueSet. IWDBoundValueSet is a utility class that can bind a DropDownByKey UI element to a context node.

IMPORTANT NOTE: This class creates a modifiable type for attrInfoSelectedKey

Parameters:

attrInfoSelectedKey - selectedKey's attribute info

dataSource - context node containing the valueset

attrInfoKey - attribute info of the element storing the key in dataSource

attrInfoValue - attribute info of the element storing the value in dataSource.

isStaticValueSet - true if the valueset content does not change at runtime.

See Also:

IWDBoundValueSet

createBoundValueSet

public static IWDBoundValueSet createBoundValueSet(IWDAttributeInfo attrInfoSelectedKey,
                                                   IWDNode dataSource,
                                                   IWDAttributeInfo attrInfoKey,
                                                   IWDAttributeInfo attrInfoValue,
                                                   IWDBoundValueSet.IWDFilterListener selection)

Create an IWDBoundValueSet. IWDBoundValueSet is a utility class that can bind a DropDownByKey UI element to a context node.

IMPORTANT NOTE: This class creates a modifiable type for attrInfoSelectedKey

Parameters:

attrInfoSelectedKey - selectedKey's attribute info

dataSource - context node containing the valueset

attrInfoKey - attribute info of the element storing the key in dataSource

attrInfoValue - attribute info of the element storing the value in dataSource.

listener - interface for custom filter

See Also:

IWDBoundValueSet

addOVSExtension

public static void addOVSExtension(java.lang.String providerName,
                                   IWDAttributeInfo[] startupAttributes,
                                   IWDNode queryInputNode,
                                   IWDNode queryResultNode,
                                   IWDOVSContextNotificationListener queryListener)

adds ovs functionalities for the specified attributes.

Parameters:

providerName - - the name of the service, it is possible

startupAttributes - - the attributes, which will be marked as startup attributes / bound uielements will be shown with ovs button

queryInputNode - - the node for the query input structure

queryResultNode - - the node for the result structure

queryListener - - a listener which can be implemented, also null can be used. It receives the hooks for apply input values, query and apply result values.

addOVSExtension

public static void addOVSExtension(java.lang.String providerName,
                                   IWDAttributeInfo[] startupAttributes,
                                   com.sap.tc.cmi.model.ICMIQuery cmiQuery,
                                   IWDOVSNotificationListener queryListener)

adds ovs extension to a valuenode/modelnode

Parameters:

providerName - - the name of the service

startupAttributes - - the attributes, which will be marked as startup attributes / bound uielements will be shown with ovs button

cmiQuery - - the query

queryListener - - a listener which can be implemented, also null can be used. It receives the hooks for apply input values, query and apply result values.

removeOVSExtension

public static void removeOVSExtension(java.lang.String providerName,
                                      IWDAttributeInfo[] startupAttributes)

removes the ovs extension from the specified attributes

Parameters:

providerName - - the name of the extension: if does not match, it is not removed.

startupAttributes - - array of pointer to the attributes, where extension is removed.