planetj.dataengine.parameter
Interface IDisplayParameter

All Superinterfaces:

Cloneable, IParameter, Serializable

All Known Implementing Classes:

ParameterManager, RequestPromptParameter

public interface IDisplayParameter

extends IParameter

A parameter which may be displayed as a prompt to the user, who might then provide a value for the parameter.

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

Method Summary

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.
FieldDescriptorRow	getDisplayFieldDescriptor() Gets the field descriptor to use when prompting the user for the parameter value.
String	getOperationString() Gets a String representing an operation which applies to this parameter.
boolean	isDisplay() Tests if this parameter should be dispalyed.
void	setOperationString(String operation) Sets a String representing an operation which applies to this parameter.

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Method Detail

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.

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.

Parameters:

ec - current context in which code is executing.

Returns:

parameter's Field object to display.

CMException

getDisplayFieldDescriptor

public FieldDescriptorRow getDisplayFieldDescriptor()
                                             throws CMException

Gets the field descriptor to use when prompting the user for the parameter value. This may or may not be the same as the target field descriptor

CMException

getOperationString

public String getOperationString()

Gets a String representing an operation which applies to this parameter. "<=", "IS NULL", and "BETWEEN" are all examples of possible operation strings

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.

setOperationString

public void setOperationString(String operation)

Sets a String representing an operation which applies to this parameter. "<=", "IS NULL", and "BETWEEN" are all examples of possible operation strings