com.businessobjects.dsws.reportengine
Interface DiscretePromptValue

All Superinterfaces:
PromptValue

public interface DiscretePromptValue
extends PromptValue

The DiscretePromptValue holds a single value to be used as a condition when running a BusinessObjects query.
A prompt is a condition on a BusinessObjects query that requires input. You will be asked to select or enter a value when they run a BusinessObjects document that contains a prompt.

For a list of prompts to be retrieved with the DocumentInformation object, the 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.

Example: Set discrete prompt values to be passed to a document.

 FillPrompts boPrompts = FillPrompts.Factory.newInstance();
 FillPrompt[] fillPromptList = new FillPrompt[1];
 fillPromptList[0] = FillPrompt.Factory.newInstance();
 fillPromptList[0].setID(boPromptInfo[0].getID());
 if (boPromptInfo[0].getAllowMultiValues())
 {
                DiscretePromptValue[] dpv = new DiscretePromptValue[2];
                dpv[0] = DiscretePromptValue.Factory.newInstance();
                dpv[1] = DiscretePromptValue.Factory.newInstance();
                dpv[0].setValue("yourValue1ForPrompt1");
                dpv[1].setValue("yourValue2ForPrompt1");
                fillPromptList[0].setValuesArray(dpv);
 } else
 {
                DiscretePromptValue[] dpv = new DiscretePromptValue[1];
                dpv[0] = DiscretePromptValue.Factory.newInstance();
                dpv[0].setValue("yourValue1ForPrompt1");
                fillPromptList[0].setValuesArray(dpv);
 }
 boPrompts.setFillPromptListArray(fillPromptList);
 Action[] actions = new Action[1];
 actions[0] = boPrompts;
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(reference,fillInfo, actions, null, retBOData);
 

See Also:
RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine, DocumentInformation

Nested Class Summary
static class DiscretePromptValue.Factory
          A class with methods for creating instances of the DiscretePromptValue type.
 
Field Summary
static org.apache.xmlbeans.SchemaType type
          Internal Use Only.
 
Method Summary
 org.apache.xmlbeans.XmlObject addNewNativeValue()
          Appends and returns a new empty NativeValue element
 org.apache.xmlbeans.XmlObject getNativeValue()
          Returns the value of the prompt.
 java.lang.String getRowIndex()
          Gets the row index for the particular dicrete prompt value from database.
 java.lang.String getValue()
          Returns the value of the prompt.
 boolean isNilNativeValue()
          Checks if the NativeValue element is nil.
 boolean isNilValue()
          Checks if the Value element is nil.
 boolean isSetNativeValue()
          Checks if the NativeValue element is set.
 boolean isSetRowIndex()
          Checks if the RowIndex attribute is set.
 boolean isSetValue()
          Checks if the Value element is set.
 void setNativeValue(org.apache.xmlbeans.XmlObject nativeValue)
          Sets the native value of the prompt.
 void setNilNativeValue()
          Sets the NativeValue element to nil.
 void setNilValue()
          Sets the Value element to nil.
 void setRowIndex(java.lang.String rowIndex)
          Sets the row index for the particular dicrete prompt value in database.
 void setValue(java.lang.String value)
          Sets the value of the prompt.
 void unsetNativeValue()
          Unsets the NativeValue element.
 void unsetRowIndex()
          Unsets the RowIndex attribute.
 void unsetValue()
          Unsets the Value element.
 org.apache.xmlbeans.XmlString xgetRowIndex()
          Internal Use Only.
 org.apache.xmlbeans.XmlString xgetValue()
          Internal Use Only.
 void xsetRowIndex(org.apache.xmlbeans.XmlString rowIndex)
          Internal Use Only.
 void xsetValue(org.apache.xmlbeans.XmlString value)
          Internal Use Only.
 

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getValue

java.lang.String getValue()
Returns the value of the prompt.

Returns:
A string containing the value of the discreet prompt.

xgetValue

org.apache.xmlbeans.XmlString xgetValue()

Internal Use Only.


isNilValue

boolean isNilValue()
Checks if the Value element is nil.

Returns:
true if the value element is nil, otherwise false

isSetValue

boolean isSetValue()
Checks if the Value element is set.

Returns:
true if the value element is set, otherwise false

setValue

void setValue(java.lang.String value)
Sets the value of the prompt.

Parameters:
value - a string containing the value of the discreet prompt.

xsetValue

void xsetValue(org.apache.xmlbeans.XmlString value)

Internal Use Only.


setNilValue

void setNilValue()
Sets the Value element to nil.


unsetValue

void unsetValue()
Unsets the Value element.


getNativeValue

org.apache.xmlbeans.XmlObject getNativeValue()
Returns the value of the prompt.

Returns:
A XmlObject containing the value of the discrete prompt.

isNilNativeValue

boolean isNilNativeValue()
Checks if the NativeValue element is nil.

Returns:
true if the value element is nil, otherwise false

isSetNativeValue

boolean isSetNativeValue()
Checks if the NativeValue element is set.

Returns:
true if the value element is set, otherwise false

setNativeValue

void setNativeValue(org.apache.xmlbeans.XmlObject nativeValue)
Sets the native value of the prompt.

Parameters:
value - a XmlObject containing the value of the discrete prompt.

addNewNativeValue

org.apache.xmlbeans.XmlObject addNewNativeValue()
Appends and returns a new empty NativeValue element

Returns:
a new empty NativeValue element

setNilNativeValue

void setNilNativeValue()
Sets the NativeValue element to nil.


unsetNativeValue

void unsetNativeValue()
Unsets the NativeValue element.


getRowIndex

java.lang.String getRowIndex()
Gets the row index for the particular dicrete prompt value from database.

Returns:
the row index of dicrete prompt value.

xgetRowIndex

org.apache.xmlbeans.XmlString xgetRowIndex()

Internal Use Only.


isSetRowIndex

boolean isSetRowIndex()
Checks if the RowIndex attribute is set.

Returns:
true if the RowIndex attribute is set, otherwise false.

setRowIndex

void setRowIndex(java.lang.String rowIndex)
Sets the row index for the particular dicrete prompt value in database.

Parameters:
the - rowIndex of the dicrete prompt value in database.

xsetRowIndex

void xsetRowIndex(org.apache.xmlbeans.XmlString rowIndex)

Internal Use Only.


unsetRowIndex

void unsetRowIndex()
Unsets the RowIndex attribute.