com.businessobjects.dsws.reportengine
Class FillPrompts

java.lang.Object
  com.businessobjects.dsws.reportengine.Action
      com.businessobjects.dsws.reportengine.FillPrompts

All Implemented Interfaces:

java.io.Serializable

public class FillPrompts

extends Action

implements java.io.Serializable

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 fillPrompts = new FillPrompts();
FillPrompt[] fillPromptList = new FillPrompt[2];
fillPromptList[0]= new FillPrompt();
fillPromptList[0].setID( promptid1 );
DiscretePromptValue[] dPromptValues = new DiscretePromptValue[1];
dPromptValues[0] = new DiscretePromptValue();
dPromptValues[0].setValue(value1);
fillPromptList[0].setValues(dPromptValues); fillPromptList[1]= new FillPrompt();
fillPromptList[1].setID(promptid2);
dPromptValues = new DiscretePromptValue[1];
dPromptValues[0] = new DiscretePromptValue();
dPromptValues[0].setValue(value2);
fillPromptList[1].setValues(dPromptValues); fillPrompts.setFillPromptList(fillPromptList);
Action[] actions = new Action[1];
actions[0] = fillPrompts;
DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strBODocuid, null, actions, null, retBOData);


See Also:

RetrieveView, RetrieveData, PromptInfo, Action, FillPrompt, DiscretePromptValue, PromptValue, RangePromptValue, ReportEngine, DocumentInformation, Serialized Form

Constructor Summary

FillPrompts()
Instantiate a new blank FillPrompts object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
FillPrompt[]	getFillPromptList() Internal Use Only.
FillPrompt	getFillPromptList(int i) Internal Use Only.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
int	hashCode() Internal Use Only.
void	setFillPromptList(FillPrompt[] fillPromptList) Set all FillPrompt objects needed by a document.
void	setFillPromptList(int i, FillPrompt value) Set an individual FillPrompt object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FillPrompts

public FillPrompts()

Instantiate a new blank FillPrompts object.

Method Detail

getFillPromptList

public FillPrompt[] getFillPromptList()

Internal Use Only.

setFillPromptList

public void setFillPromptList(FillPrompt[] fillPromptList)

Set all FillPrompt objects needed by a document.

Parameters:

fillPromptList - an array of FillPrompt objects.

getFillPromptList

public FillPrompt getFillPromptList(int i)

Internal Use Only.

setFillPromptList

public void setFillPromptList(int i,
                              FillPrompt value)

Set 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.

value - An individual FillPrompt object.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

Overrides:

equals in class Action

hashCode

public int hashCode()

Internal Use Only.

Overrides:

hashCode in class Action

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.