com.businessobjects.enterprise.crystalreport
Interface PromptValue

public interface PromptValue

Stores detailed information about the parameter value itself.

Nested Class Summary

static class

PromptValue.Factory A class with methods for creating instances of the PromptValue type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

MaximumValue	addNewMaximumValue() Appends and returns a new empty MaximumValue object.
MinimumValue	addNewMinimumValue() Appends and returns a new empty MinimumValue object.
ReportParameterValueOptions	addNewOptions() Internal Use Only.
java.lang.String	getData() Returns the actual value.
java.lang.String	getDescription() Returns a description of the parameter value.
MaximumValue	getMaximumValue() Returns the maximum value a parameter may have.
MinimumValue	getMinimumValue() Returns the minimum value a parameter may have.
ReportParameterValueOptions	getOptions() Internal Use Only.
boolean	getShowDescriptionOnlyEnabled() 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.
boolean	isSetData() Checks if the Data element has been set.
boolean	isSetDescription() Checks if the Description has been set.
boolean	isSetMaximumValue() Checks if the MaximumValue has been set.
boolean	isSetMinimumValue() Checks if the MinimumValue has been set.
boolean	isSetOptions() Internal Use Only.
boolean	isSetShowDescriptionOnlyEnabled() Checks if the ShowDescriptionOnlyEnabled has been set.
void	setData(java.lang.String data) Sets the actual value.
void	setDescription(java.lang.String description) Sets a description of the parameter value.
void	setMaximumValue(MaximumValue maximumValue) Sets the maximum value a parameter may have.
void	setMinimumValue(MinimumValue minimumValue) Sets the minimum value a parameter may have.
void	setOptions(ReportParameterValueOptions options) Internal Use Only.
void	setShowDescriptionOnlyEnabled(boolean showDescriptionOnlyEnabled) 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	unsetData() Deletes or unsets the Data element.
void	unsetDescription() Deletes or unsets the Description element.
void	unsetMaximumValue() Deletes or unsets the MaximumValue element.
void	unsetMinimumValue() Deletes or unsets the MinimumValue element.
void	unsetOptions() Internal Use Only.
void	unsetShowDescriptionOnlyEnabled() Deletes or unsets the ShowDescriptionOnlyEnabled element.
org.apache.xmlbeans.XmlString	xgetData() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetShowDescriptionOnlyEnabled() Internal Use Only.
void	xsetData(org.apache.xmlbeans.XmlString data) Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetShowDescriptionOnlyEnabled(org.apache.xmlbeans.XmlBoolean showDescriptionOnlyEnabled) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getOptions

ReportParameterValueOptions getOptions()

Internal Use Only.

isSetOptions

boolean isSetOptions()

Internal Use Only.

setOptions

void setOptions(ReportParameterValueOptions options)

Internal Use Only.

addNewOptions

ReportParameterValueOptions addNewOptions()

Internal Use Only.

unsetOptions

void unsetOptions()

Internal Use Only.

getShowDescriptionOnlyEnabled

boolean getShowDescriptionOnlyEnabled()

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, otherwise false.

xgetShowDescriptionOnlyEnabled

org.apache.xmlbeans.XmlBoolean xgetShowDescriptionOnlyEnabled()

Internal Use Only.

isSetShowDescriptionOnlyEnabled

boolean isSetShowDescriptionOnlyEnabled()

Checks if the ShowDescriptionOnlyEnabled has been set.

Returns:

true if the SetShowDescriptionOnlyEnabled element has been set, otherwise false.

setShowDescriptionOnlyEnabled

void setShowDescriptionOnlyEnabled(boolean showDescriptionOnlyEnabled)

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:

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

xsetShowDescriptionOnlyEnabled

void xsetShowDescriptionOnlyEnabled(org.apache.xmlbeans.XmlBoolean showDescriptionOnlyEnabled)

Internal Use Only.

unsetShowDescriptionOnlyEnabled

void unsetShowDescriptionOnlyEnabled()

Deletes or unsets the ShowDescriptionOnlyEnabled element.

getDescription

java.lang.String getDescription()

Returns a description of the parameter value.

Returns:

A String containing a description of the parameter value.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isSetDescription

boolean isSetDescription()

Checks if the Description has been set.

Returns:

true if the Description element has been set, otherwise false.

setDescription

void setDescription(java.lang.String description)

Sets a description of the parameter value.

Parameters:

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

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

unsetDescription

void unsetDescription()

Deletes or unsets the Description element.

getData

java.lang.String getData()

Returns the actual value.

Returns:

A String containing the actual value.

xgetData

org.apache.xmlbeans.XmlString xgetData()

Internal Use Only.

isSetData

boolean isSetData()

Checks if the Data element has been set.

Returns:

true if the Data element has been set, otherwise false.

setData

void setData(java.lang.String data)

Sets the actual value.

Parameters:

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

xsetData

void xsetData(org.apache.xmlbeans.XmlString data)

Internal Use Only.

unsetData

void unsetData()

Deletes or unsets the Data element.

getMinimumValue

MinimumValue getMinimumValue()

Returns the minimum value a parameter may have. In the case of strings this is the length. This value is only enforced if range checking is enabled.

Returns:

The minimum value.

isSetMinimumValue

boolean isSetMinimumValue()

Checks if the MinimumValue has been set.

Returns:

true if the MinimumValue element has been set, otherwise false.

setMinimumValue

void setMinimumValue(MinimumValue minimumValue)

Sets the minimum value a parameter may have.

Parameters:

minimumValue - The minimum value.

addNewMinimumValue

MinimumValue addNewMinimumValue()

Appends and returns a new empty MinimumValue object.

Returns:

The MinimumValue object.

unsetMinimumValue

void unsetMinimumValue()

Deletes or unsets the MinimumValue element.

getMaximumValue

MaximumValue getMaximumValue()

Returns the maximum value a parameter may have. In the case of strings this is the length. This value is only enforced if range checking is enabled.

Returns:

The maximum value.

isSetMaximumValue

boolean isSetMaximumValue()

Checks if the MaximumValue has been set.

Returns:

true if the MaximumValue element has been set, otherwise false.

setMaximumValue

void setMaximumValue(MaximumValue maximumValue)

Sets the maximum value a parameter may have.

Parameters:

maximumValue - The maximum value.

addNewMaximumValue

MaximumValue addNewMaximumValue()

Appends and returns a new empty MaximumValue object.

Returns:

The MaximumValue object.

unsetMaximumValue

void unsetMaximumValue()

Deletes or unsets the MaximumValue element.