com.businessobjects.dsws.reportengine
Class FillPrompt

java.lang.Object
  com.businessobjects.dsws.reportengine.FillPrompt

All Implemented Interfaces:

java.io.Serializable

public class FillPrompt

extends java.lang.Object

implements java.io.Serializable

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 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, FillPrompts, DiscretePromptValue, PromptValue, RangePromptValue, ReportEngine, DocumentInformation, Serialized Form

Constructor Summary

FillPrompt()
Instantiate a new blank FillPrompt 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) Get Custom Deserializer
java.lang.String	getID() Internal Use Only.
FillPrompt[]	getParentPromptValues() Internal Use Only.
FillPrompt	getParentPromptValues(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) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
PromptValue[]	getValues() Internal Use Only.
PromptValue	getValues(int i) Internal Use Only.
int	hashCode()
void	setID(java.lang.String ID) Set the ID of this object.
void	setParentPromptValues(FillPrompt[] parentPromptValues) Set the ParentPromptValues to the FillPrompt.
void	setParentPromptValues(int i, FillPrompt value) Set the ParentPromptValues to the FillPrompt at the ith position.
void	setValues(int i, PromptValue value) Set a single PromptValue in the PromptValues array.
void	setValues(PromptValue[] values) Set an array of PromptValues to be passed to the document when it is refreshed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FillPrompt

public FillPrompt()

Instantiate a new blank FillPrompt object.

Method Detail

getValues

public PromptValue[] getValues()

Internal Use Only.

setValues

public void setValues(PromptValue[] values)

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

Parameters:

values - an array of PromptValues.

getValues

public PromptValue getValues(int i)

Internal Use Only.

setValues

public void setValues(int i,
                      PromptValue value)

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

value - a single PromptValue.

getParentPromptValues

public FillPrompt[] getParentPromptValues()

Internal Use Only.

setParentPromptValues

public void setParentPromptValues(FillPrompt[] parentPromptValues)

Set the ParentPromptValues to the FillPrompt.

getParentPromptValues

public FillPrompt getParentPromptValues(int i)

Internal Use Only.

setParentPromptValues

public void setParentPromptValues(int i,
                                  FillPrompt value)

Set the ParentPromptValues to the FillPrompt at the ith position.

getID

public java.lang.String getID()

Internal Use Only.

setID

public void setID(java.lang.String ID)

Set the ID of this object.

Parameters:

ID - the ID of this object.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

hashCode

public int hashCode()

getTypeDesc

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

Return type metadata object

getSerializer

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

Get Custom Serializer

getDeserializer

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

Get Custom Deserializer