planetj.dataengine.parameter
Class AbstractNamedParameter

java.lang.Object
  planetj.dataengine.parameter.AbstractParameter
      planetj.dataengine.parameter.AbstractNamedParameter

All Implemented Interfaces:

java.lang.Cloneable, IJDBCSQLParameter, INamedParameter, IParameter, java.io.Serializable

Direct Known Subclasses:

GlobalAttributeParameter, RequestAttributeParameter, RequestParameter, SessionAttributeParameter

public abstract class AbstractNamedParameter

extends AbstractParameter

implements INamedParameter, IJDBCSQLParameter

A parameter which gets its value from an Session

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, PARAMETER_VALUE_ACTUAL, PARAMETER_VALUE_DISPLAY, PARAMETER_VALUE_UNKNOWN

Constructor Summary

AbstractNamedParameter()

Method Summary

java.lang.String	getParameterName() Gets the name of this parameter (may be null).
java.lang.String	getValueKey() Gets the key with which this parameter's value is stored in the request
void	setToken(java.lang.String token) Sets the literal token that was used to denote this parameter in code
protected void	setValueKey(java.lang.String valueKey) Sets the key with which this parameter's value is stored in the request

Methods inherited from class planetj.dataengine.parameter.AbstractParameter

clearValue, clone, cloneParameter, equals, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getDefaultValueAsString, getId, getSource, getTargetFieldDescriptor, getToken, getValue, hasAssignedValue, hashCode, isSQLParameter, isValueLoaded, loadValueFromSource, loadValueFromSource, setContext, setContextIndex, setContextInternal, setDataType, setDefaultValueAsString, setSource, setSQLParameter, setTokenInternal, setValue, setValueInternal, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Constructor Detail

AbstractNamedParameter

public AbstractNamedParameter()

Method Detail

getParameterName

public java.lang.String getParameterName()
                                  throws CMException

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

Specified by:

getParameterName in interface INamedParameter

Throws:

CMException

getValueKey

public java.lang.String getValueKey()
                             throws CMException

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

Throws:

CMException

setValueKey

protected void setValueKey(java.lang.String valueKey)

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

setToken

public void setToken(java.lang.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

Throws:

CMException