com.businessobjects.dsws.reportengine
Interface FillPrompts

All Superinterfaces:

Action

public interface FillPrompts
extends Action

FillPrompts holds an array of FillPrompt objects 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, FillPrompt, DiscretePromptValue, PromptValue, RangePromptValue, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

FillPrompt	addNewFillPromptList() Appends and returns a new empty value as the last FillPromptList element
FillPrompt[]	getFillPromptListArray() Internal Use Only.
FillPrompt	getFillPromptListArray(int i) Internal Use Only.
FillPrompt	insertNewFillPromptList(int i) Inserts and returns a new empty value as the ith FillPromptList element
boolean	isNilFillPromptListArray(int i) Checks if the FillPromptList element is nil at the specified index position.
void	removeFillPromptList(int i) Removes the FillPromptList element from the specifie index position.
void	setFillPromptListArray(FillPrompt[] fillPromptListArray) Sets the array of FillPrompt objects needed by a document.
void	setFillPromptListArray(int i, FillPrompt fillPromptList) Sets an individual FillPrompt object.
void	setNilFillPromptListArray(int i) Sets the FillPromptList element to nil at the specified position.
int	sizeOfFillPromptListArray() Returns the number of FillPromptList element.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getFillPromptListArray

FillPrompt[] getFillPromptListArray()

Internal Use Only.

getFillPromptListArray

FillPrompt getFillPromptListArray(int i)

Internal Use Only.

isNilFillPromptListArray

boolean isNilFillPromptListArray(int i)

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

Parameters:

i - the index of the FillPromptList element.

Returns:

true if the FillPromptList element is nil, otherwise false.

sizeOfFillPromptListArray

int sizeOfFillPromptListArray()

Returns the number of FillPromptList element.

Returns:

the size of the FillPromptList array.

setFillPromptListArray

void setFillPromptListArray(FillPrompt[] fillPromptListArray)

Sets the array of FillPrompt objects needed by a document.

Parameters:

fillPromptListArray - an array of FillPrompt objects.

setFillPromptListArray

void setFillPromptListArray(int i,
                            FillPrompt fillPromptList)

Sets an individual FillPrompt object.

Note: Before using this function,

#setFillPromptList(com.businessobjects.dsws.reportengine.FillPrompt[] fillPromptList) has to be called to initialize the array.

Parameters:

i - The index of the FillPrompt to be set.

fillPromptList - An individual FillPrompt object.

setNilFillPromptListArray

void setNilFillPromptListArray(int i)

Sets the FillPromptList element to nil at the specified position.

Parameters:

i - the index of the FillPromptList element

insertNewFillPromptList

FillPrompt insertNewFillPromptList(int i)

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

Parameters:

i - the index of the FillPromptList element

Returns:

a new empty value as the ith FillPromptList element

addNewFillPromptList

FillPrompt addNewFillPromptList()

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

Returns:

a new empty value as the last FillPromptList element

removeFillPromptList

void removeFillPromptList(int i)

Removes the FillPromptList element from the specifie index position.

Parameters:

i - the index of the FillPromptList element