planetj.dataengine.parameter
Class RequestPromptParameter

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

All Implemented Interfaces:

Cloneable, IDisplayParameter, IJDBCSQLParameter, INamedParameter, IParameter, Serializable

Direct Known Subclasses:

SQLPromptParameter, TableParameter

public abstract class RequestPromptParameter

extends RequestParameter

implements IDisplayParameter

A parameter which can be displayed as a prompt to the user. After the user enters a value, that value is stored in the HttpServletRequest. It can then be extracted from the request into this object.

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

RequestPromptParameter()

Method Summary

Object	clearValue() Clears this parameter's value, returning the current value after it has been cleared.
IParameter	cloneParameter() Clones this parameter
Field	getDisplayField() Deprecated. (6/11/2003 7:43:20 AM) This method will not allow setting the Field's default value from a user property. Replaced by getDisplayField(ExecutingContext)
Field	getDisplayField(ExecutingContext ec) Gets the field to use when displaying a prompt to the user.
boolean	isDisplay() Tests if this parameter should be dispalyed.
void	setDisplay(boolean display) Sets if this parameter should be dispalyed.
void	setToken(String token) Sets the literal token that was used to denote this parameter in code

Methods inherited from class planetj.dataengine.parameter.RequestParameter

getParameterName, getRequestKey, loadValueFromSource

Methods inherited from class planetj.dataengine.parameter.AbstractParameter

clone, 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.IDisplayParameter

getDisplayFieldDescriptor, getOperationString, setOperationString

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Constructor Detail

RequestPromptParameter

public RequestPromptParameter()

Method Detail

clearValue

public Object clearValue()
                  throws CMException

Clears this parameter's value, returning the current value after it has been cleared. Any validation exceptions are also cleared

Specified by:

clearValue in interface IParameter

Overrides:

clearValue in class AbstractParameter

CMException

cloneParameter

public IParameter cloneParameter()

Clones this parameter

Specified by:

cloneParameter in interface IParameter

Overrides:

cloneParameter in class AbstractParameter

getDisplayField

public Field getDisplayField()
                      throws CMException

Deprecated. (6/11/2003 7:43:20 AM) This method will not allow setting the Field's default value from a user property. Replaced by getDisplayField(ExecutingContext)

Gets the field to use when displaying a prompt to the user.

Specified by:

getDisplayField in interface IDisplayParameter

Returns:

parameters field object to display.

CMException

getDisplayField

public Field getDisplayField(ExecutingContext ec)
                      throws CMException

Gets the field to use when displaying a prompt to the user.

Specified by:

getDisplayField in interface IDisplayParameter

Parameters:

ec - current context in which code is executing.

Returns:

parameter's Field object to display.

CMException

isDisplay

public boolean isDisplay()

Tests if this parameter should be dispalyed. Implementing the IDisplayParameter interface indicates that this parameter *can* be displayed, not whether it *should* be displayed.

Specified by:

isDisplay in interface IDisplayParameter

setDisplay

public void setDisplay(boolean display)

Sets if this parameter should be dispalyed. Implementing the IDisplayParameter interface indicates that this parameter *can* be displayed, not whether it *should* be displayed.

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 RequestParameter

CMException