com.businessobjects.dsws.reportengine
Interface RangePromptValue

All Superinterfaces:

PromptValue

public interface RangePromptValue
extends PromptValue

A RangePromptValue holds a range of values to be used as a condition when running a BusinessObjects query.
A prompt is a parameter on a BusinessObjects query that requires input. Users are asked to select or enter a value when they refresh a BusinessObjects document that contains a prompt.

To retrieve a list of prompts with the DocumentInformation object, a RetrievePromptsInfo object must be added to the RetrieveMustFillInfo object passed to the ReportEngine.getDocumentInformation method.

Use the retrieved list of PromptInfo to recuperate values to be passed to the BusinessObjects query.

Go to DiscretePromptValue to see an example of how to use Prompts.

See Also:

DiscretePromptValue, RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

org.apache.xmlbeans.XmlObject	addNewNativeEndValue() Appends and returns a new empty NativeEndValue element.
org.apache.xmlbeans.XmlObject	addNewNativeStartValue() Appends and returns a new empty NativeStartValue element.
java.lang.String	getEndValue() Returns the last allowable value in the range of values to be used in the prompt condition.
boolean	getEndValueInclusive() Returns true if the end value is included in the range of allowable values.
boolean	getEndValueUnbound() Returns true if there is no upper bound to the acceptable range.
org.apache.xmlbeans.XmlObject	getNativeEndValue() Gets the NativeEndValue element.
org.apache.xmlbeans.XmlObject	getNativeStartValue() Gets the NativeStartValue element.
java.lang.String	getStartValue() Returns the first allowable value in the range of values to be used in the prompt condition.
boolean	getStartValueInclusive() Returns true if the start value is included in the range of allowable values.
boolean	getStartValueUnbound() Returns true if there is no lower bound to the acceptable range.
boolean	isNilEndValue() Checks if the EndValue element is nil.
boolean	isNilNativeEndValue() Checks if the NativeEndValue element is nil.
boolean	isNilNativeStartValue() Checks if the NativeStartValue element is nil.
boolean	isNilStartValue() Checks if the StartValue element is nil
boolean	isSetEndValue() Checks if the EndValue element is set.
boolean	isSetEndValueInclusive() Checks if the EndValueInclusive attribute is set.
boolean	isSetEndValueUnbound() Checks if the EndValueUnbound attribute is set.
boolean	isSetNativeEndValue() Checks if the NativeEndValue element is set.
boolean	isSetNativeStartValue() Checks if the NativeStartValue element is set.
boolean	isSetStartValue() Checks if the StartValue element is set.
boolean	isSetStartValueInclusive() Checks if the StartValueInclusive attribute is set.
boolean	isSetStartValueUnbound() Checks if the StartValueUnbound attribute is set.
void	setEndValue(java.lang.String endValue) Sets the last allowable value in the range of values to be used in the prompt condition.
void	setEndValueInclusive(boolean endValueInclusive) Set to true if the end value is included in the range of allowable values.
void	setEndValueUnbound(boolean endValueUnbound) Set to true if there is no upper bound to the acceptable range.
void	setNativeEndValue(org.apache.xmlbeans.XmlObject nativeEndValue) Sets the NativeEndValue element.
void	setNativeStartValue(org.apache.xmlbeans.XmlObject nativeStartValue) Sets the NativeStartValue element.
void	setNilEndValue() Sets the EndValue element to nil.
void	setNilNativeEndValue() Sets the NativeEndValue element to nil.
void	setNilNativeStartValue() Sets the NativeStartValue element to nil.
void	setNilStartValue() Sets the StartValue element to nil.
void	setStartValue(java.lang.String startValue) Sets the first allowable value in the range of values to be used in the prompt condition.
void	setStartValueInclusive(boolean startValueInclusive) Set to true if the start value is included in the range of allowable values.
void	setStartValueUnbound(boolean startValueUnbound) Set to true if there is no lower bound to the acceptable range.
void	unsetEndValue() Unsets the EndValue element.
void	unsetEndValueInclusive() Unsets the EndValueInclusive attribute.
void	unsetEndValueUnbound() Unsets the "EndValueUnbound" attribute
void	unsetNativeEndValue() Unsets the "NativeEndValue" element.
void	unsetNativeStartValue() Unsets the NativeStartValue element.
void	unsetStartValue() Unsets the StartValue element.
void	unsetStartValueInclusive() Unsets the "StartValueInclusive" attribute.
void	unsetStartValueUnbound() Unsets the StartValueUnbound attribute.
org.apache.xmlbeans.XmlString	xgetEndValue() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetEndValueInclusive() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetEndValueUnbound() Internal use only
org.apache.xmlbeans.XmlString	xgetStartValue() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetStartValueInclusive() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetStartValueUnbound() Internal use only
void	xsetEndValue(org.apache.xmlbeans.XmlString endValue) Internal use only
void	xsetEndValueInclusive(org.apache.xmlbeans.XmlBoolean endValueInclusive) Internal use only
void	xsetEndValueUnbound(org.apache.xmlbeans.XmlBoolean endValueUnbound) Internal use only
void	xsetStartValue(org.apache.xmlbeans.XmlString startValue) Internal use only
void	xsetStartValueInclusive(org.apache.xmlbeans.XmlBoolean startValueInclusive) Internal use only.
void	xsetStartValueUnbound(org.apache.xmlbeans.XmlBoolean startValueUnbound) Internal use only

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getStartValue

java.lang.String getStartValue()

Returns the first allowable value in the range of values to be used in the prompt condition.

Returns:

the first allowable value.

xgetStartValue

org.apache.xmlbeans.XmlString xgetStartValue()

Internal use only

isNilStartValue

boolean isNilStartValue()

Checks if the StartValue element is nil

Returns:

true if the StartValue element is nil, otherwise false

isSetStartValue

boolean isSetStartValue()

Checks if the StartValue element is set.

Returns:

true if the StartValue element is set, otherwise false

setStartValue

void setStartValue(java.lang.String startValue)

Sets the first allowable value in the range of values to be used in the prompt condition.

Parameters:

startValue - the first allowable value.

xsetStartValue

void xsetStartValue(org.apache.xmlbeans.XmlString startValue)

Internal use only

setNilStartValue

void setNilStartValue()

Sets the StartValue element to nil.

unsetStartValue

void unsetStartValue()

Unsets the StartValue element.

getNativeStartValue

org.apache.xmlbeans.XmlObject getNativeStartValue()

Gets the NativeStartValue element.

Returns:

The native start value.

isNilNativeStartValue

boolean isNilNativeStartValue()

Checks if the NativeStartValue element is nil.

Returns:

true if the NativeStartValue element is nil, otherwise false.

isSetNativeStartValue

boolean isSetNativeStartValue()

Checks if the NativeStartValue element is set.

Returns:

true if the NativeStartValue element is set, otherwise false.

setNativeStartValue

void setNativeStartValue(org.apache.xmlbeans.XmlObject nativeStartValue)

Sets the NativeStartValue element.

Parameters:

nativeStartValue - The NaticeStartValue element.

addNewNativeStartValue

org.apache.xmlbeans.XmlObject addNewNativeStartValue()

Appends and returns a new empty NativeStartValue element.

Returns:

a new empty NativeStartValue element.

setNilNativeStartValue

void setNilNativeStartValue()

Sets the NativeStartValue element to nil.

unsetNativeStartValue

void unsetNativeStartValue()

Unsets the NativeStartValue element.

getEndValue

java.lang.String getEndValue()

Returns the last allowable value in the range of values to be used in the prompt condition.

Returns:

the last allowable value.

xgetEndValue

org.apache.xmlbeans.XmlString xgetEndValue()

Internal use only

isNilEndValue

boolean isNilEndValue()

Checks if the EndValue element is nil.

Returns:

true if the EndValue element is nil, otherwise false.

isSetEndValue

boolean isSetEndValue()

Checks if the EndValue element is set.

Returns:

true if the EndValue element is set, otherwise false.

setEndValue

void setEndValue(java.lang.String endValue)

Sets the last allowable value in the range of values to be used in the prompt condition.

Parameters:

endValue - the last allowable value.

xsetEndValue

void xsetEndValue(org.apache.xmlbeans.XmlString endValue)

Internal use only

setNilEndValue

void setNilEndValue()

Sets the EndValue element to nil.

unsetEndValue

void unsetEndValue()

Unsets the EndValue element.

getNativeEndValue

org.apache.xmlbeans.XmlObject getNativeEndValue()

Gets the NativeEndValue element.

Returns:

A XmlObject containing the native end value.

isNilNativeEndValue

boolean isNilNativeEndValue()

Checks if the NativeEndValue element is nil.

Returns:

true if the NativeEndValue element is nil, otherwise false.

isSetNativeEndValue

boolean isSetNativeEndValue()

Checks if the NativeEndValue element is set.

Returns:

true if the NativeEndValue element is set, otherwise false.

setNativeEndValue

void setNativeEndValue(org.apache.xmlbeans.XmlObject nativeEndValue)

Sets the NativeEndValue element.

Parameters:

nativeEndValue - The native end element.

addNewNativeEndValue

org.apache.xmlbeans.XmlObject addNewNativeEndValue()

Appends and returns a new empty NativeEndValue element.

Returns:

a new empty NativeEndValue element.

setNilNativeEndValue

void setNilNativeEndValue()

Sets the NativeEndValue element to nil.

unsetNativeEndValue

void unsetNativeEndValue()

Unsets the "NativeEndValue" element.

getStartValueInclusive

boolean getStartValueInclusive()

Returns true if the start value is included in the range of allowable values.

Returns:

true if the start value is included in the range of allowable values.

xgetStartValueInclusive

org.apache.xmlbeans.XmlBoolean xgetStartValueInclusive()

Internal use only

isSetStartValueInclusive

boolean isSetStartValueInclusive()

Checks if the StartValueInclusive attribute is set.

Returns:

true if the StartValueInclusive attribute is set, otherwise false.

setStartValueInclusive

void setStartValueInclusive(boolean startValueInclusive)

Set to true if the start value is included in the range of allowable values.

Parameters:

startValueInclusive - true if the start value is included in the range of allowable values, otherwise false.

xsetStartValueInclusive

void xsetStartValueInclusive(org.apache.xmlbeans.XmlBoolean startValueInclusive)

Internal use only.

unsetStartValueInclusive

void unsetStartValueInclusive()

Unsets the "StartValueInclusive" attribute.

getStartValueUnbound

boolean getStartValueUnbound()

Returns true if there is no lower bound to the acceptable range.

Returns:

true if there is no lower bound to the acceptable range, otherwise false.

xgetStartValueUnbound

org.apache.xmlbeans.XmlBoolean xgetStartValueUnbound()

Internal use only

isSetStartValueUnbound

boolean isSetStartValueUnbound()

Checks if the StartValueUnbound attribute is set.

Returns:

true if the StartValueUnbound element is set, otherwise false.

setStartValueUnbound

void setStartValueUnbound(boolean startValueUnbound)

Set to true if there is no lower bound to the acceptable range.

Parameters:

startValueUnbound - true if there is no lower bound to the acceptable range, otherwise false.

xsetStartValueUnbound

void xsetStartValueUnbound(org.apache.xmlbeans.XmlBoolean startValueUnbound)

Internal use only

unsetStartValueUnbound

void unsetStartValueUnbound()

Unsets the StartValueUnbound attribute.

getEndValueInclusive

boolean getEndValueInclusive()

Returns true if the end value is included in the range of allowable values.

Returns:

true if the end value is included in the range of allowable values.

xgetEndValueInclusive

org.apache.xmlbeans.XmlBoolean xgetEndValueInclusive()

Internal use only

isSetEndValueInclusive

boolean isSetEndValueInclusive()

Checks if the EndValueInclusive attribute is set.

Returns:

true if the EndValueInclusive element is set, otherwise false.

setEndValueInclusive

void setEndValueInclusive(boolean endValueInclusive)

Set to true if the end value is included in the range of allowable values.

Parameters:

endValueInclusive - true if the end value is included in the range of allowable values.

xsetEndValueInclusive

void xsetEndValueInclusive(org.apache.xmlbeans.XmlBoolean endValueInclusive)

Internal use only

unsetEndValueInclusive

void unsetEndValueInclusive()

Unsets the EndValueInclusive attribute.

getEndValueUnbound

boolean getEndValueUnbound()

Returns true if there is no upper bound to the acceptable range.

Returns:

true if there is no upper bound to the acceptable range.

xgetEndValueUnbound

org.apache.xmlbeans.XmlBoolean xgetEndValueUnbound()

Internal use only

isSetEndValueUnbound

boolean isSetEndValueUnbound()

Checks if the EndValueUnbound attribute is set.

Returns:

true if the EndValueUnbound attribute is set, otherwise false.

setEndValueUnbound

void setEndValueUnbound(boolean endValueUnbound)

Set to true if there is no upper bound to the acceptable range.

Parameters:

endValueUnbound - true if there is no upper bound to the acceptable range.

xsetEndValueUnbound

void xsetEndValueUnbound(org.apache.xmlbeans.XmlBoolean endValueUnbound)

Internal use only

unsetEndValueUnbound

void unsetEndValueUnbound()

Unsets the "EndValueUnbound" attribute