planetj.dataengine.parameter
Class ExecutingContextParameter

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

All Implemented Interfaces:

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

public class ExecutingContextParameter

extends AbstractParameter

implements IJDBCSQLParameter, IExecutingContextSource

A parameter which gets its value from an ExecutingContext

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

ExecutingContextParameter()

Method Summary

java.lang.String	getExecutingContextKey() Gets the key with which this parameter's value is stored in the ExecutingContext
java.lang.Object	loadValueFromSource(java.lang.Object source, int valueType) Loads this parameter's value from a source.
protected void	setExecutingContextKey(java.lang.String newECKey) Sets the key with which this parameter's value is stored in the ExecutingContext
void	setToken(java.lang.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, getId, getSource, getTargetFieldDescriptor, getToken, getValue, hasAssignedValue, hashCode, isSQLParameter, isValueLoaded, 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.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Constructor Detail

ExecutingContextParameter

public ExecutingContextParameter()

Method Detail

getExecutingContextKey

public java.lang.String getExecutingContextKey()
                                        throws CMException

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

Throws:

CMException

loadValueFromSource

public java.lang.Object loadValueFromSource(java.lang.Object source,
                                            int valueType)
                                     throws CMException

Description copied from interface: IParameter

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

Overrides:

loadValueFromSource in class AbstractParameter

Throws:

CMException

setExecutingContextKey

protected void setExecutingContextKey(java.lang.String newECKey)

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

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