com.crystaldecisions.sdk.plugin.desktop.common
Interface IReportParameterSingleValue

All Superinterfaces:

IReportParameterValue

public interface IReportParameterSingleValue
extends IReportParameterValue

The IReportParameterSingleValue interface stores detailed information about the parameter value itself, if it is a single value. For range values, see the IReportParameterRangeValue interface. Valuable information is also contained in the IReportParameterValue interface description.

See Also:

IReportParameterValue, IReportParameterRangeValue

Nested Class Summary

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IReportParameterValue

IReportParameterValue.DateFormat

Method Summary

java.util.List	getAncestors() FOR INTERNAL USE ONLY Returns the Ancestors of the value.
java.lang.String	getDescription() Returns a description of the parameter value.
java.lang.String	getDisplayValue() FOR INTERNAL USE ONLY Returns the actual display value.
java.lang.String	getValue() Returns the actual value.
boolean	isShowDescriptionOnly() Returns whether the description of the value is shown when the user must choose a value, or both the value and the value's description are shown.
void	setAncestors(java.util.List ancestors) FOR INTERNAL USE ONLY Sets the Ancestors of the value.
void	setDescription(java.lang.String bstrDesc) Sets a description of the parameter value.
void	setDisplayValue(java.lang.String val) FOR INTERNAL USE ONLY Sets the actual display value.
void	setShowDescriptionOnly(boolean bShowDescOnly) Sets whether the description of the value is shown when the user must choose a value, or both the value and the value's description are shown.
void	setValue(java.lang.String bstrVal) Sets the actual value.

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IReportParameterValue

getParameterFieldValue, isNull, makeDisplayString, setNull

Method Detail

getDescription

java.lang.String getDescription()

Returns a description of the parameter value.

Returns:

A String containing a description of the parameter value.

setDescription

void setDescription(java.lang.String bstrDesc)

Sets a description of the parameter value.

Parameters:

bstrDesc - A String containing a description of the parameter value.

isShowDescriptionOnly

boolean isShowDescriptionOnly()

Returns whether the description of the value is shown when the user must choose a value, or both the value and the value's description are shown.

Returns:

true if only the description of the value is shown, false otherwise.

setShowDescriptionOnly

void setShowDescriptionOnly(boolean bShowDescOnly)

Sets whether the description of the value is shown when the user must choose a value, or both the value and the value's description are shown.

Parameters:

bShowDescOnly - true if only the description of the value is shown, false otherwise.

getValue

java.lang.String getValue()

Returns the actual value.

Returns:

A String containing the actual value.

setValue

void setValue(java.lang.String bstrVal)

Sets the actual value.

Parameters:

bstrVal - A String containing the actual value to be set.

getAncestors

java.util.List getAncestors()

FOR INTERNAL USE ONLY

Returns the Ancestors of the value. The list will be null or empty if the value is not hierarchical.

Returns:

the Ancestors of the value.

setAncestors

void setAncestors(java.util.List ancestors)

FOR INTERNAL USE ONLY

Sets the Ancestors of the value.

Parameters:

ancestors - The ancestors of the value. The list should be null or empty if the value is not hierarchical.

getDisplayValue

java.lang.String getDisplayValue()

FOR INTERNAL USE ONLY

Returns the actual display value.

Returns:

A String containing the actual display value.

setDisplayValue

void setDisplayValue(java.lang.String val)

FOR INTERNAL USE ONLY

Sets the actual display value.

Parameters:

bstrVal - A String containing the actual display value to be set.