com.businessobjects.dsws.reportengine
Interface LOVSearch

public interface LOVSearch

The LOVSearch objects are associated with RetrieveDrillInfo and RetrievePromptsInfo object. Using a LOV Search, values of the LOV can be filtered based on the pattern selected. You can also filter the LOV values by making case sensitive aware. When a non null LOVSearch is passed, it applies to all the LOVs that will be returned by the web service call. You can perform LOVSearch on all the prompts existing in the Web Intelligence document.

Example: Illustrating LOVSearch on the selected prompt

 LOVSearch objLOVSearch = LOVSearch.Factory.newInstance();
 objLOVSearch.setPattern("*a*");
 objLOVSearch.setCaseSensitive(true);
 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrievePromptsInfo promptInfo = RetrievePromptsInfo.Factory.newInstance();
 promptInfo.setPromptLOVRetrievalMode(PromptLOVRetrievalMode.SELECTED);
 promptInfo.setRefreshReturnedLOVs(true);
 promptInfo.setReturnLOVOnMustFillPrompts(false);
 String[] selectPrompt=new String[1];
 selectPrompt[0]="ROOT.0";
 // Set the list of prompt IDs to be retrieved
 promptInfo.setSelectPromptsArray(selectPrompt);
 promptInfo.setLOVSearch(objLOVSearch);
 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

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

boolean	getCaseSensitive() Internal Use Only.
java.lang.String	getPattern() Internal Use Only.
void	setCaseSensitive(boolean caseSensitive) Sets a Case Sensitive check to be applied on LOV values.
void	setPattern(java.lang.String pattern) Sets a search pattern to be applied on LOV values.
org.apache.xmlbeans.XmlBoolean	xgetCaseSensitive() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPattern() Internal Use Only.
void	xsetCaseSensitive(org.apache.xmlbeans.XmlBoolean caseSensitive) Internal Use Only.
void	xsetPattern(org.apache.xmlbeans.XmlString pattern) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getPattern

java.lang.String getPattern()

Internal Use Only.

xgetPattern

org.apache.xmlbeans.XmlString xgetPattern()

Internal Use Only.

setPattern

void setPattern(java.lang.String pattern)

Sets a search pattern to be applied on LOV values.

Parameters:

pattern - - the search pattern to be applied on LOV values.

xsetPattern

void xsetPattern(org.apache.xmlbeans.XmlString pattern)

Internal Use Only.

getCaseSensitive

boolean getCaseSensitive()

Internal Use Only.

xgetCaseSensitive

org.apache.xmlbeans.XmlBoolean xgetCaseSensitive()

Internal Use Only.

setCaseSensitive

void setCaseSensitive(boolean caseSensitive)

Sets a Case Sensitive check to be applied on LOV values.

Parameters:

caseSensitive - - the case sensitive check to be applied on LOV values.

xsetCaseSensitive

void xsetCaseSensitive(org.apache.xmlbeans.XmlBoolean caseSensitive)

Internal Use Only.