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 inherited from class com.crystaldecisions.sdk.plugin.desktop.common.IReportParameterValue
IReportParameterValue.DateFormat
 
Method Summary
 java.lang.String getDescription()
           Returns a description of the parameter 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 setDescription(java.lang.String bstrDesc)
           Sets a description of the parameter 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

public java.lang.String getDescription()

Returns a description of the parameter value.

Returns:
A String containing a description of the parameter value.

setDescription

public 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

public 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

public 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

public java.lang.String getValue()

Returns the actual value.

Returns:
A String containing the actual value.

setValue

public void setValue(java.lang.String bstrVal)

Sets the actual value.

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