com.arcway.cockpit.docgen.provider.interfaces

Interface IParameterStore

public interface IParameterStore

The IParameterStore provides methods to store and request parameters for report templates. The interface is used to store input parameters requested from the user so that these parameters can be used as default values for teh next time the report is generated be this user. Paremeters are identifeid by a key which has to be unique within the report template. Different report templates use different parameter stores so the parameters of repirt templates are seperated automatically. The IParameterStore can be referenced directly within a document template by its name parameterStore.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Integer>	requestIntegerListParameter(java.lang.String parameterKey, java.util.List<java.lang.Integer> defaultValueList) Tries to retrieve the request parameter in the report templates parameter store.
int	requestIntParameter(java.lang.String parameterKey, int defaultValue) Tries to retrieve the request parameter in the report templates parameter store.
java.lang.String	requestStringParameter(java.lang.String parameterKey, java.lang.String defaultValue) Tries to retrieve the request parameter in the report templates parameter store.
void	storeIntegerListParameter(java.lang.String parameterKey, java.util.List<java.lang.Integer> valueList) Stores a String parameter in the report templates paremeter store
void	storeIntParameter(java.lang.String parameterKey, int value) Stores a String parameter in the report templates paremeter store
void	storeStringParameter(java.lang.String parameterKey, java.lang.String value) Stores a String parameter in the report templates paremeter store

Method Detail

storeStringParameter

void storeStringParameter(java.lang.String parameterKey,
                          java.lang.String value)

Stores a String parameter in the report templates paremeter store

Parameters:

parameterKey - identifies the parameter

value - value to be stored

requestStringParameter

java.lang.String requestStringParameter(java.lang.String parameterKey,
                                        java.lang.String defaultValue)

Tries to retrieve the request parameter in the report templates parameter store. Returns a given default value, if the parameter can not be found.

Parameters:

parameterKey - identifies the parameter

defaultValue - is returned, when the parameter had not been saved yet

Returns:

requestd parameter or given default value

storeIntParameter

void storeIntParameter(java.lang.String parameterKey,
                       int value)

Stores a String parameter in the report templates paremeter store

Parameters:

parameterKey - identifies the parameter

value - value to be stored

requestIntParameter

int requestIntParameter(java.lang.String parameterKey,
                        int defaultValue)

Tries to retrieve the request parameter in the report templates parameter store. Returns a given default value, if the parameter can not be found.

Parameters:

parameterKey - identifies the parameter

defaultValue - is returned, when the parameter had not been saved yet

Returns:

requestd parameter or given default value

storeIntegerListParameter

void storeIntegerListParameter(java.lang.String parameterKey,
                               java.util.List<java.lang.Integer> valueList)

Stores a String parameter in the report templates paremeter store

Parameters:

parameterKey - identifies the parameter

valueList - list of Integer value to be stored

requestIntegerListParameter

java.util.List<java.lang.Integer> requestIntegerListParameter(java.lang.String parameterKey,
                                                              java.util.List<java.lang.Integer> defaultValueList)

Tries to retrieve the request parameter in the report templates parameter store. Returns a given default value, if the parameter can not be found.

Parameters:

parameterKey - identifies the parameter

defaultValueList - is returned, when the parameter had not been saved yet

Returns:

requestd parameter or given default value