com.businessobjects.dsws.reportengine
Interface LOVBatch

public interface LOVBatch

The LOVBatch objects are associated with RetrieveDrillInfo and RetrievePromptsInfo object. Using a LOV Batch, values of the LOV can be retrieved in batches. When a non null LOVBatch is passed, it applies to all the LOVs that will be returned by the web service call.

Example: Retrieve the List Of Values in batches.

 LOVBatch objLOVBatch = LOVBatch.Factory.newInstance();
 objLOVBatch.setIndex(0);

 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrievePromptsInfo promptInfo = RetrievePromptsInfo.Factory.newInstance();
 promptInfo.setPromptLOVRetrievalMode(PromptLOVRetrievalMode.ALL);
 fillInfo.setRetrievePromptsInfo(promptInfo);
 promptInfo.setRefreshReturnedLOVs(false);
 promptInfo.setReturnLOVOnMustFillPrompts(true);
 promptInfo.setLOVBatch(objLOVBatch);
 fillInfo.setRetrievePromptsInfo(promptInfo);
 Action[] actions = new Action[1];
 // Add a Refresh action to the Action array.
 actions[0] = Refresh.Factory.newInstance();
 // Obtain a DocumentInformation object from the ReportEngine.
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(strDocid,fillInfo,actions,null,null);
 

Since:

11.7

See Also:

LOV, RetrieveDrillInfo, RetrievePromptsInfo

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

int	getIndex() Internal Use Only.
void	setIndex(int index) Sets the index to retrieve corresponding List Of Values batch.
org.apache.xmlbeans.XmlInt	xgetIndex() Internal Use Only.
void	xsetIndex(org.apache.xmlbeans.XmlInt index) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getIndex

int getIndex()

Internal Use Only.

xgetIndex

org.apache.xmlbeans.XmlInt xgetIndex()

Internal Use Only.

setIndex

void setIndex(int index)

Sets the index to retrieve corresponding List Of Values batch.

Parameters:

index - - sets the requested Batch Index.

xsetIndex

void xsetIndex(org.apache.xmlbeans.XmlInt index)

Internal Use Only.