planetj.dataengine.parameter
Interface IJDBCSQLParameter

All Superinterfaces:

Cloneable, IParameter, Serializable

All Known Implementing Classes:

ContextParameterParameter, ExecutingContextParameter, FieldOrUsageIdParameter, ParameterParameter, RequestAttribute, RequestParameter, RuntimeParameter

public interface IJDBCSQLParameter

extends IParameter

A parameter whose value may possibly be sent to a Database Manager as a parameter. (As opposed to a parameter whose value must be grafted into the SQL statement before it is sent to the DB). The isSQLParameter() method tests if the parameter's value should actually be sent as parameter (implementing this interface indicates that it may be, not that it definitely should be).

Field Summary

Fields inherited from interface planetj.dataengine.parameter.IParameter

CONTEXT_SPECIFIC_ID_END, CONTEXT_SPECIFIC_ID_START, DEFAULT_DATA_TYPE, ID_START, PARAMETER_INDEX_PREFIX

Method Summary

boolean	isSQLParameter() Tests if this parameter should be sent as a parameter to the DB if it is included in a SQL statement.
void	setSQLParameter(boolean sqlp) Sets if this parameter should be sent as a parameter to the DB if it is included in a SQL statement.

Methods inherited from interface planetj.dataengine.parameter.IParameter

clearValue, clone, cloneParameter, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getSource, getTargetFieldDescriptor, getToken, getValue, loadValueFromSource, setContext, setDataType, setSource, setToken, setValue

Method Detail

isSQLParameter

public boolean isSQLParameter()

Tests if this parameter should be sent as a parameter to the DB if it is included in a SQL statement. The DB can handle fewer type of parameters than the DataEngine, so not all DataEngine parameters can be sent as parameters to the DB. (For example, table names cannot be sent as DB parameters.) If this parameter is not part of an SQL statement then it does not matter what this method returns.

setSQLParameter

public void setSQLParameter(boolean sqlp)

Sets if this parameter should be sent as a parameter to the DB if it is included in a SQL statement. The DB can handle fewer type of parameters than the DataEngine, so not all DataEngine parameters can be sent as parameters to the DB. (For example, table names cannot be sent as DB parameters.)