com.ibm.commerce.rest.javadoc

Class AbstractJdbcValueProvider

java.lang.Object

com.ibm.commerce.rest.javadoc.AbstractJdbcValueProvider

All Implemented Interfaces:

ValueProvider

Direct Known Subclasses:

CurrencyIdProvider, LanguageIdProvider, LocaleProvider, StoreIdProvider

public abstract class AbstractJdbcValueProvider
extends java.lang.Object
implements ValueProvider

Used to fetch values and their description based on a JDBC query.

Field Summary

Fields inherited from interface com.ibm.commerce.rest.javadoc.ValueProvider

HANDLER_TO_DOCUMENT, JAVA_HANDLER_METHOD, JAVA_OBJECT_CLASS, JAVA_OBJECT_FIELD, PARAMETER_NAME, REQUEST_EXECUTION_HANDLER

Constructor Summary

Constructors

Constructor and Description
AbstractJdbcValueProvider() Constructor

Method Summary

Modifier and Type	Method and Description
Value[]	getValuesFromJdbc(java.lang.String componentName, java.lang.String queryName, java.lang.String valueName, java.lang.String descriptionName, java.util.Map queryParameters) Fetch values from a JDBC query.
static boolean	isJdbcValueProvidersEnabled()
static void	setJdbcValueProvidersEnabled(boolean setEnabled)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.rest.javadoc.ValueProvider

getValues

Constructor Detail

AbstractJdbcValueProvider

public AbstractJdbcValueProvider()

Constructor

Method Detail

setJdbcValueProvidersEnabled

public static void setJdbcValueProvidersEnabled(boolean setEnabled)

Parameters:

setEnabled - Enable or disable the JDBC value providers.

isJdbcValueProvidersEnabled

public static boolean isJdbcValueProvidersEnabled()

Returns:

True if the JDBC value providers are enabled.

getValuesFromJdbc

public Value[] getValuesFromJdbc(java.lang.String componentName,
                                 java.lang.String queryName,
                                 java.lang.String valueName,
                                 java.lang.String descriptionName,
                                 java.util.Map queryParameters)

Fetch values from a JDBC query.

Parameters:

componentName - The component name.

queryName - The query name.

valueName - The value column name.

descriptionName - The description column name.

queryParameters - The SQL query parameters to use.

Returns:

The fetched values.