org.pentaho.platform.api.engine
Interface IParameterProvider

All Known Subinterfaces:

IParameterSetter

All Known Implementing Classes:

BaseParameterProvider, CustomSettingsParameterProvider, FlashChartRequestMapper, HttpRequestParameterProvider, HttpSessionParameterProvider, JVMParameterProvider, PentahoSessionParameterProvider, PortletPreferencesParameterProvider, PortletRequestParameterProvider, PortletSessionParameterProvider, SecurityParameterProvider, SimpleParameterProvider, SimpleParameterSetter, SystemSettingsParameterProvider

public interface IParameterProvider

A ParameterProvider is a source for input, output or resource parameters for a given action. The parameter definitions exist within the SequenceDefinition. The values for the parameters are supplied from the ParameterProvider.

Field Summary

static java.lang.String	SCOPE_REQUEST
static java.lang.String	SCOPE_SESSION

Method Summary

java.lang.Object[]	getArrayParameter(java.lang.String name, java.lang.Object[] defaultValue) Retrieve the requested parameter as an Object array
java.util.Date	getDateParameter(java.lang.String name, java.util.Date defaultValue) Retrieve the requested parameter as type java.util.Date.
java.math.BigDecimal	getDecimalParameter(java.lang.String name, java.math.BigDecimal defaultValue) Retrieve the requested parameter as decimal, returning a java.lang.Object.
long	getLongParameter(java.lang.String name, long defaultValue) Retrieve the requested parameter as primitive Java type long.
java.lang.Object	getParameter(java.lang.String name) Gets the named parameter from the provider as it's native type
java.util.Iterator	getParameterNames() Return list of all avialable parameter names in this provider
java.lang.String[]	getStringArrayParameter(java.lang.String name, java.lang.String[] defaultValue) Retrieve the requested parameter as a String array
java.lang.String	getStringParameter(java.lang.String name, java.lang.String defaultValue) Retrieve the requested parameter as type java.lang.String
boolean	hasParameter(java.lang.String name)

Field Detail

SCOPE_REQUEST

static final java.lang.String SCOPE_REQUEST

See Also:

Constant Field Values

SCOPE_SESSION

static final java.lang.String SCOPE_SESSION

See Also:

Constant Field Values

Method Detail

getStringParameter

java.lang.String getStringParameter(java.lang.String name,
                                    java.lang.String defaultValue)

Retrieve the requested parameter as type java.lang.String

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter, or the defaultValue if not found

getLongParameter

long getLongParameter(java.lang.String name,
                      long defaultValue)

Retrieve the requested parameter as primitive Java type long.

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter, or the defaultValue if not found

getDateParameter

java.util.Date getDateParameter(java.lang.String name,
                                java.util.Date defaultValue)

Retrieve the requested parameter as type java.util.Date.

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter, or the defaultValue if not found

getDecimalParameter

java.math.BigDecimal getDecimalParameter(java.lang.String name,
                                         java.math.BigDecimal defaultValue)

Retrieve the requested parameter as decimal, returning a java.lang.Object.

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter, or the defaultValue if not found

getArrayParameter

java.lang.Object[] getArrayParameter(java.lang.String name,
                                     java.lang.Object[] defaultValue)

Retrieve the requested parameter as an Object array

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter converted to an array if it wasn't already an array, or the defaultValue if not found

getStringArrayParameter

java.lang.String[] getStringArrayParameter(java.lang.String name,
                                           java.lang.String[] defaultValue)

Retrieve the requested parameter as a String array

Parameters:

name - name of parameter to retrieve

defaultValue - value to return if the named parameter can not be found

Returns:

value of requested parameter converted to a String array if it wasn't already a String array, or the defaultValue if not found

getParameterNames

java.util.Iterator getParameterNames()

Return list of all avialable parameter names in this provider

Returns:

Set of parameter names

getParameter

java.lang.Object getParameter(java.lang.String name)

Gets the named parameter from the provider as it's native type

Parameters:

name - The name of the parameter to retrieve

Returns:

The native object

hasParameter

boolean hasParameter(java.lang.String name)

Parameters:

name - Name of the parameter to look up

Returns:

true if the parameter exists in the parameter provider