planetj.dataengine.parameter
Class UserParameter

java.lang.Object
  planetj.dataengine.parameter.AbstractParameter
      planetj.dataengine.parameter.FieldOrUsageIdParameter
          planetj.dataengine.parameter.UserParameter

All Implemented Interfaces:

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

public class UserParameter

extends FieldOrUsageIdParameter

A parameter which can extract its value from an IUser object. The extraction can either be based on a usage id or a field name

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

UserParameter()

Method Summary

java.lang.Object	loadValueFromSource(java.lang.Object source, int valueType) Loads this parameter's value from a source.
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.FieldOrUsageIdParameter

getParameterName, getValueKey, isFieldNameParameter, isUsageIdParameter, 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

Constructor Detail

UserParameter

public UserParameter()

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

setToken

public void setToken(java.lang.String token)

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

Specified by:

setToken in interface IParameter

Overrides:

setToken in class AbstractParameter