planetj.dataengine.parameter
Class GlobalAttributeParameter

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SQLTextReplacementParameter

public class GlobalAttributeParameter

extends AbstractNamedParameter

A parameter which gets its value from an HttpServletRequest that were stored globably either from custom programming or through Row inserts and updates.

See Also:

Serialized Form

Field Summary

static java.lang.String

GLOBAL_REQUEST_ATTRIBUTES

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

GlobalAttributeParameter()

Method Summary

static java.lang.Object	getGlobalAttribute(java.lang.String key, ExecutingContext ec) Gets an attribute from a Map of globabl attributes for the given key.
java.lang.Object	loadValueFromSource(java.lang.Object source, int valueType) Loads this parameter's value from a source.
static void	setGlobalAttribute(java.lang.String key, java.lang.Object attribute, ExecutingContext ec) Puts the given attribute in a Map of globabl attributes stored by the specified key.

Methods inherited from class planetj.dataengine.parameter.AbstractNamedParameter

getParameterName, getValueKey, setToken, setValueKey

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.IParameter

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

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Field Detail

GLOBAL_REQUEST_ATTRIBUTES

public static final java.lang.String GLOBAL_REQUEST_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

GlobalAttributeParameter

public GlobalAttributeParameter()

Method Detail

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

setGlobalAttribute

public static void setGlobalAttribute(java.lang.String key,
                                      java.lang.Object attribute,
                                      ExecutingContext ec)

Puts the given attribute in a Map of globabl attributes stored by the specified key.

Parameters:

key -

attribute -

ec -

getGlobalAttribute

public static java.lang.Object getGlobalAttribute(java.lang.String key,
                                                  ExecutingContext ec)

Gets an attribute from a Map of globabl attributes for the given key.

Parameters:

key -

ec -