planetj.dataengine.parameter
Class RequestParameter

java.lang.Object
  |
  +--planetj.dataengine.parameter.AbstractParameter
        |
        +--planetj.dataengine.parameter.RequestParameter

All Implemented Interfaces:

Cloneable, IJDBCSQLParameter, INamedParameter, IParameter, Serializable

Direct Known Subclasses:

RequestPromptParameter

public class RequestParameter

extends AbstractParameter

implements INamedParameter, IJDBCSQLParameter

A parameter which gets its value from an HttpServletRequest

See Also:

Serialized Form

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

Constructor Summary

RequestParameter()

Method Summary

String	getParameterName() Gets the name of this parameter (may be null).
String	getRequestKey() Gets the key with which this parameter's value is stored in the request
Object	loadValueFromSource(Object source) Loads this parameter's value from a source.
void	setToken(String token) Sets the literal token that was used to denote this parameter in code

Methods inherited from class planetj.dataengine.parameter.AbstractParameter

clearValue, clone, cloneParameter, equals, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getDefaultValueAsString, getSource, getTargetFieldDescriptor, getToken, getValue, hashCode, isSQLParameter, setContext, setDataType, setDefaultValueAsString, setSource, setSQLParameter, setValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Constructor Detail

RequestParameter

public RequestParameter()

Method Detail

getParameterName

public String getParameterName()
                        throws CMException

Gets the name of this parameter (may be null).

Specified by:

getParameterName in interface INamedParameter

CMException

getRequestKey

public String getRequestKey()
                     throws CMException

Gets the key with which this parameter's value is stored in the request

CMException

loadValueFromSource

public Object loadValueFromSource(Object source)
                           throws CMException

Loads this parameter's value from a source. The object passed in may be ignored if the parameter already knows the source from which its value should be extracted.

Specified by:

loadValueFromSource in interface IParameter

CMException

setToken

public void setToken(String token)
              throws CMException

Sets the literal token that was used to denote this parameter in code

Specified by:

setToken in interface IParameter

Overrides:

setToken in class AbstractParameter

CMException