com.businessobjects.dsws.reportengine
Interface FillPrompt

public interface FillPrompt

A FillPrompt holds an array of PromptValues to be used as a condition when running a BusinessObjects query.
A prompt is a condition on a BusinessObjects query that requires input. Users are 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, a RetrievePromptsInfo object must be added to the RetrieveMustFillInfo object passed to the ReportEngine.getDocumentInformation method.

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

Example: Setting prompts for a document refresh.

 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);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOData.setRetrieveView(retBOView);

 actions[0] = boPrompts;
 boDocInfo = boRepEng.getDocumentInformation(reference,fillInfo, actions, null, retBOData);
 

See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

FillPrompt	addNewParentPromptValues() Appends and returns a new empty value as the last ParentPromptValues element
PromptValue	addNewValues() Appends and returns a new empty value as the last Values element
java.lang.String	getID() Internal Use Only.
FillPrompt[]	getParentPromptValuesArray() Gets an array of all ParentPromptValues elements.
FillPrompt	getParentPromptValuesArray(int i) Gets the ParentPromptValues element at the specified index position.
PromptValue[]	getValuesArray() Internal Use Only.
PromptValue	getValuesArray(int i) Internal Use Only.
FillPrompt	insertNewParentPromptValues(int i) Inserts and returns a new empty value as the ith ParentPromptValues element
PromptValue	insertNewValues(int i) Inserts and returns a new empty value as the ith Values element
boolean	isNilParentPromptValuesArray(int i) Checks if the ParentPromptValues element is nil at the specified index location.
boolean	isNilValuesArray(int i) Checks if the Values element is nil at the specified index position.
void	removeParentPromptValues(int i) Removes the ParentPromptValues element from the specified index position.
void	removeValues(int i) Removes the Values element from the specified index position.
void	setID(java.lang.String id) Sets the ID of this object.
void	setNilParentPromptValuesArray(int i) Sets the ParentPromptValues element at the specified index position.
void	setNilValuesArray(int i) Checks if the Values element is nil at the specified index position.
void	setParentPromptValuesArray(FillPrompt[] parentPromptValuesArray) Sets the array of all ParentPromptValues element.
void	setParentPromptValuesArray(int i, FillPrompt parentPromptValues) Sets the ParentPromptValues to the FillPrompt at the specified index position.
void	setValuesArray(int i, PromptValue values) Sets a single PromptValue in the PromptValues array.
void	setValuesArray(PromptValue[] valuesArray) Sets an array of PromptValues to be passed to the document when it is refreshed.
int	sizeOfParentPromptValuesArray() Returns the number of ParentPromptValues element.
int	sizeOfValuesArray() Returns the number of Values element.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getValuesArray

PromptValue[] getValuesArray()

Internal Use Only.

getValuesArray

PromptValue getValuesArray(int i)

Internal Use Only.

isNilValuesArray

boolean isNilValuesArray(int i)

Checks if the Values element is nil at the specified index position.

Parameters:

i - the index of the Values element

Returns:

true if the values element is nil, otherwise false

sizeOfValuesArray

int sizeOfValuesArray()

Returns the number of Values element.

Returns:

the size of the Values array.

setValuesArray

void setValuesArray(PromptValue[] valuesArray)

Sets an array of PromptValues to be passed to the document when it is refreshed.

Parameters:

valuesArray - an array of PromptValues.

setValuesArray

void setValuesArray(int i,
                    PromptValue values)

Sets a single PromptValue in the PromptValues array.

Note: Before using this function,

#setValues(com.businessobjects.dsws.reportengine.PromptValue[] values) has to be called to initialize the array.

Parameters:

i - The index of the PromptValue to be set.

values - a single PromptValue.

setNilValuesArray

void setNilValuesArray(int i)

Checks if the Values element is nil at the specified index position.

Parameters:

i - the index of the Values element

insertNewValues

PromptValue insertNewValues(int i)

Inserts and returns a new empty value as the ith Values element

Parameters:

i - the index of the Values element

Returns:

a new empty value as the ith Values element

addNewValues

PromptValue addNewValues()

Appends and returns a new empty value as the last Values element

Returns:

a new empty value as the last Values element

removeValues

void removeValues(int i)

Removes the Values element from the specified index position.

Parameters:

i - the index of the Values element

getParentPromptValuesArray

FillPrompt[] getParentPromptValuesArray()

Gets an array of all ParentPromptValues elements.

Returns:

the array of FillPrompt elements

getParentPromptValuesArray

FillPrompt getParentPromptValuesArray(int i)

Gets the ParentPromptValues element at the specified index position.

Parameters:

i - the index of the ParentPromptValues element

Returns:

the FillPrompt instance

isNilParentPromptValuesArray

boolean isNilParentPromptValuesArray(int i)

Checks if the ParentPromptValues element is nil at the specified index location.

Parameters:

i - the index of the ParentPromptValues element

Returns:

true if the ParentPromptValues element is nil, otherwise false

sizeOfParentPromptValuesArray

int sizeOfParentPromptValuesArray()

Returns the number of ParentPromptValues element.

Returns:

the size of the ParentPromptValues element.

setParentPromptValuesArray

void setParentPromptValuesArray(FillPrompt[] parentPromptValuesArray)

Sets the array of all ParentPromptValues element.

Parameters:

parentPromptValuesArray - the array of FillPrompt elements

setParentPromptValuesArray

void setParentPromptValuesArray(int i,
                                FillPrompt parentPromptValues)

Sets the ParentPromptValues to the FillPrompt at the specified index position.

Parameters:

i - the index of the ParentPromptValues element

parentPromptValues - the FillPrompt instance

setNilParentPromptValuesArray

void setNilParentPromptValuesArray(int i)

Sets the ParentPromptValues element at the specified index position.

Parameters:

i - the index of the ParentPromptValues element

insertNewParentPromptValues

FillPrompt insertNewParentPromptValues(int i)

Inserts and returns a new empty value as the ith ParentPromptValues element

Parameters:

i - the index of the ParentPromptValues element

Returns:

a new empty value as the ith ParentPromptValues element

addNewParentPromptValues

FillPrompt addNewParentPromptValues()

Appends and returns a new empty value as the last ParentPromptValues element

Returns:

a new empty value as the last ParentPromptValues element

removeParentPromptValues

void removeParentPromptValues(int i)

Removes the ParentPromptValues element from the specified index position.

Parameters:

i - the index of the ParentPromptValues element

getID

java.lang.String getID()

Internal Use Only.

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Sets the ID of this object.

Parameters:

ID - the ID of this object.

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.