com.businessobjects.dsws.reportengine
Interface RetrievePromptsInfo

public interface RetrievePromptsInfo

RetrievePromptsInfo interface is used to retrieve the PromptsInfo objects necessary for a successful document refresh.
The PromptInfo objects are returned inside the DocumentInformation object retrieved by the
ReportEngine.getDocumentInformation Web Service call.
You can enter a value from the List of Values depending on the properties of the prompt. Prompts can have more than one value. Prompts must be filled each time a document is refreshed.
Example: Retrieve the list of prompts used by the document.

 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrievePromptsInfo promptInfo = RetrievePromptsInfo.Factory.newInstance();
 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);
 String reference = boDocInfo.getDocumentReference();
 if (boDocInfo.getMustFillPrompts())
 {
                PromptInfo[] boPromptInfo = boDocInfo.getPromptInfoArray();
 }
 

See Also:

RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DataSourceParameterValue	addNewDataSourceParameterValues() Appends and returns a new empty value as the last DataSourceParameterValues element
LOVBatch	addNewLOVBatch() Appends and returns a new empty LOVBatch element
LOVSearch	addNewLOVSearch() Appends and returns a new empty LOVSearch element
LOVSort	addNewLOVSort() Appends and returns a new empty "LOVSort" element
org.apache.xmlbeans.XmlString	addNewSelectPrompts() Appends and returns a new empty value as the last SelectPrompts element
void	addSelectPrompts(java.lang.String selectPrompts) Appends the value as the last SelectPrompts element.
DataSourceParameterValue[]	getDataSourceParameterValuesArray() Internal Use Only.
DataSourceParameterValue	getDataSourceParameterValuesArray(int i) Internal Use Only.
LOVBatch	getLOVBatch() Internal Use Only.
LOVSearch	getLOVSearch() Internal Use Only.
LOVSort	getLOVSort() Internal Use Only.
PromptLOVRetrievalMode.Enum	getPromptLOVRetrievalMode() Internal Use Only.
boolean	getRefreshReturnedLOVs() Internal Use Only.
boolean	getReturnLOVOnMustFillPrompts() Internal Use Only.
java.lang.String[]	getSelectPromptsArray() Internal Use Only.
java.lang.String	getSelectPromptsArray(int i) Internal Use Only.
DataSourceParameterValue	insertNewDataSourceParameterValues(int i) Inserts and returns a new empty value as the ith DataSourceParameterValues element
org.apache.xmlbeans.XmlString	insertNewSelectPrompts(int i) Inserts and returns a new empty value as the ith SelectPrompts element
void	insertSelectPrompts(int i, java.lang.String selectPrompts) Inserts the value as the ith SelectPrompts element.
boolean	isNilDataSourceParameterValuesArray(int i) Checks if the DataSourceParameterValues element is nil at the specified index position.
boolean	isNilLOVBatch() Tests for nil "LOVBatch" element
boolean	isNilLOVSearch() Checks if the LOVSearch element is nil.
boolean	isNilLOVSort() Checks if the LOVSort element is nil.
boolean	isNilSelectPromptsArray(int i) Checks if the SelectPrompts element is nil.
boolean	isSetLOVBatch() True if has "LOVBatch" element
boolean	isSetLOVSearch() Checks if the LOVSearch element is set.
boolean	isSetLOVSort() Checks if the LOVSort element is set.
void	removeDataSourceParameterValues(int i) Removes the DataSourceParameterValues element at the specified index position.
void	removeSelectPrompts(int i) Removes the SelectPrompts element at the specified index position.
void	setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray) Sets the array of DataSourceParameterValues element.
void	setDataSourceParameterValuesArray(int i, DataSourceParameterValue dataSourceParameterValues) Sets the DataSourceParameterValues element at the specified index position.
void	setLOVBatch(LOVBatch lovBatch) Sets an LOVBatch object to specify which batch/chunk of the List Of Values(LOV) you want to retrieve.
void	setLOVSearch(LOVSearch lovSearch) Sets the LOVSearch object to specify how you want to filter List Of Values(LOV).
void	setLOVSort(LOVSort lovSort) Sets the LOVSort object to specify how you want to sort List Of Values(LOV) you are going to retrieve.
void	setNilDataSourceParameterValuesArray(int i) Sets the DataSourceParameterValues element to nil at the specified index position.
void	setNilLOVBatch() Sets the LOVBatch element to nil.
void	setNilLOVSearch() Sets the LOVSearch element to nil.
void	setNilLOVSort() Nils the "LOVSort" element
void	setNilSelectPromptsArray(int i) Sets the SelectPrompts element to nil at the specified index position.
void	setPromptLOVRetrievalMode(PromptLOVRetrievalMode.Enum promptLOVRetrievalMode) Restricts the way List Of Values for Prompts are retrieved.
void	setRefreshReturnedLOVs(boolean refreshReturnedLOVs) Set to true if selected List Of Values(LOV) are refreshed before being returned in the DocumentInformation object.
void	setReturnLOVOnMustFillPrompts(boolean returnLOVOnMustFillPrompts) Set to true to improve performance by retrieving only necessary prompt information.
void	setSelectPromptsArray(int i, java.lang.String selectPrompts) Sets the ID of a single prompt to be retrieved.
void	setSelectPromptsArray(java.lang.String[] selectPromptsArray) Sets the list of prompt IDs to be retrieved.
int	sizeOfDataSourceParameterValuesArray() Returns the size of the DataSourceParameterValues array.
int	sizeOfSelectPromptsArray() Returns the size of the SelectPrompt array.
void	unsetLOVBatch() Unsets the LOVBatch element.
void	unsetLOVSearch() Unsets the LOVSearch element.
void	unsetLOVSort() Unsets the "LOVSort" element
PromptLOVRetrievalMode	xgetPromptLOVRetrievalMode() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshReturnedLOVs() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetReturnLOVOnMustFillPrompts() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetSelectPromptsArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetSelectPromptsArray(int i) Internal Use Only.
void	xsetPromptLOVRetrievalMode(PromptLOVRetrievalMode promptLOVRetrievalMode) Internal Use Only.
void	xsetRefreshReturnedLOVs(org.apache.xmlbeans.XmlBoolean refreshReturnedLOVs) Internal Use Only.
void	xsetReturnLOVOnMustFillPrompts(org.apache.xmlbeans.XmlBoolean returnLOVOnMustFillPrompts) Internal Use Only.
void	xsetSelectPromptsArray(int i, org.apache.xmlbeans.XmlString selectPrompts) Internal Use Only.
void	xsetSelectPromptsArray(org.apache.xmlbeans.XmlString[] selectPromptsArray) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getSelectPromptsArray

java.lang.String[] getSelectPromptsArray()

Internal Use Only.

getSelectPromptsArray

java.lang.String getSelectPromptsArray(int i)

Internal Use Only.

xgetSelectPromptsArray

org.apache.xmlbeans.XmlString[] xgetSelectPromptsArray()

Internal Use Only.

xgetSelectPromptsArray

org.apache.xmlbeans.XmlString xgetSelectPromptsArray(int i)

Internal Use Only.

isNilSelectPromptsArray

boolean isNilSelectPromptsArray(int i)

Checks if the SelectPrompts element is nil.

Parameters:

i - the index of the SelectPrompt element

Returns:

true if the SelectPrompt element is nil, otherwise false

sizeOfSelectPromptsArray

int sizeOfSelectPromptsArray()

Returns the size of the SelectPrompt array.

Returns:

the size of the SelectPrompt array

setSelectPromptsArray

void setSelectPromptsArray(java.lang.String[] selectPromptsArray)

Sets the list of prompt IDs to be retrieved. The PromptInfo are returned in the DocumentInformation object retrieved by the * @param selectPrompts
ReportEngine.getDocumentInformation Web Service call. Note: To consider this list of prompt IDs, call setPromptLOVRetrievalMode (PromptLOVRetrievalMode.SELECTED) on RetrievePromptInfo object.

Parameters:

selectPromptsArray - - the list of prompt IDs to be returned.

setSelectPromptsArray

void setSelectPromptsArray(int i,
                           java.lang.String selectPrompts)

Sets the ID of a single prompt to be retrieved. The PromptInfo are returned in the DocumentInformation object retrieved by
the ReportEngine.getDocumentInformation Web Service call.
Note: For this list of prompt IDs to be taken into account, setPromptLOVRetrievalMode
(PromptLOVRetrievalMode.SELECTED) must be called on this RetrievePromptInfo object.
Note: Before using this function, call setSelectPrompts(java.lang.String[] selectPrompts) to initialize the array.

Parameters:

i - - The index of the prompt to be retrieved.

selectPrompts - - a single prompt ID to be retrieved.

xsetSelectPromptsArray

void xsetSelectPromptsArray(org.apache.xmlbeans.XmlString[] selectPromptsArray)

Internal Use Only.

xsetSelectPromptsArray

void xsetSelectPromptsArray(int i,
                            org.apache.xmlbeans.XmlString selectPrompts)

Internal Use Only.

setNilSelectPromptsArray

void setNilSelectPromptsArray(int i)

Sets the SelectPrompts element to nil at the specified index position.

Parameters:

i - the index of the SelectPrompt element

insertSelectPrompts

void insertSelectPrompts(int i,
                         java.lang.String selectPrompts)

Inserts the value as the ith SelectPrompts element.

Parameters:

i - the index of the SelectPrompt element.

selectPrompts - the String value of the selected prompt.

addSelectPrompts

void addSelectPrompts(java.lang.String selectPrompts)

Appends the value as the last SelectPrompts element.

Parameters:

selectPrompts - the String value of the selected prompt.

insertNewSelectPrompts

org.apache.xmlbeans.XmlString insertNewSelectPrompts(int i)

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

Parameters:

i - the index of the SelectPrompt element

Returns:

a new empty value (as xml) as the ith SelectPrompts element

addNewSelectPrompts

org.apache.xmlbeans.XmlString addNewSelectPrompts()

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

Returns:

a new empty value as the last SelectPrompts element

removeSelectPrompts

void removeSelectPrompts(int i)

Removes the SelectPrompts element at the specified index position.

Parameters:

i - the index of the SelectPrompt element

getLOVSearch

LOVSearch getLOVSearch()

Internal Use Only.

isNilLOVSearch

boolean isNilLOVSearch()

Checks if the LOVSearch element is nil.

Returns:

true if the LOVSearch element is nil, otherwise false

isSetLOVSearch

boolean isSetLOVSearch()

Checks if the LOVSearch element is set.

Returns:

true if the LOVSearch element is set, otherwise false

setLOVSearch

void setLOVSearch(LOVSearch lovSearch)

Sets the LOVSearch object to specify how you want to filter List Of Values(LOV).
If null, the search will not be performed on the returned lists of values.

Parameters:

lovSearch - - an object containing LOVSearch criteria.

See Also:

LOVSearch

addNewLOVSearch

LOVSearch addNewLOVSearch()

Appends and returns a new empty LOVSearch element

Returns:

a new empty LOVSearch element

setNilLOVSearch

void setNilLOVSearch()

Sets the LOVSearch element to nil.

unsetLOVSearch

void unsetLOVSearch()

Unsets the LOVSearch element.

getLOVSort

LOVSort getLOVSort()

Internal Use Only.

isNilLOVSort

boolean isNilLOVSort()

Checks if the LOVSort element is nil.

Returns:

true if the LOVSort element is nil, otherwise false

isSetLOVSort

boolean isSetLOVSort()

Checks if the LOVSort element is set.

Returns:

true if the LOVSort element is set, otherwise false

setLOVSort

void setLOVSort(LOVSort lovSort)

Sets the LOVSort object to specify how you want to sort List Of Values(LOV) you are going to retrieve.
If null, the sort will not be performed on the returned lists of values.

Parameters:

lovSort - - an object containing LOVSort parameters.

See Also:

LOVSort

addNewLOVSort

LOVSort addNewLOVSort()

Appends and returns a new empty "LOVSort" element

Returns:

a new empty "LOVSort" element

setNilLOVSort

void setNilLOVSort()

Nils the "LOVSort" element

unsetLOVSort

void unsetLOVSort()

Unsets the "LOVSort" element

getLOVBatch

LOVBatch getLOVBatch()

Internal Use Only.

isNilLOVBatch

boolean isNilLOVBatch()

Tests for nil "LOVBatch" element

Returns:

true if the LOVBatch element is nil, otherwise false

isSetLOVBatch

boolean isSetLOVBatch()

True if has "LOVBatch" element

Returns:

true if the LOVBatch element is set, otherwise false

setLOVBatch

void setLOVBatch(LOVBatch lovBatch)

Sets an LOVBatch object to specify which batch/chunk of the List Of Values(LOV) you want to retrieve.
If null, the chunk/batch will not be performed on the returned lists of values.

Parameters:

lovBatch - - an object containing LOVBatch parameters.

See Also:

LOVBatch

addNewLOVBatch

LOVBatch addNewLOVBatch()

Appends and returns a new empty LOVBatch element

Returns:

a new empty LOVBatch element

setNilLOVBatch

void setNilLOVBatch()

Sets the LOVBatch element to nil.

unsetLOVBatch

void unsetLOVBatch()

Unsets the LOVBatch element.

getDataSourceParameterValuesArray

DataSourceParameterValue[] getDataSourceParameterValuesArray()

Internal Use Only.

getDataSourceParameterValuesArray

DataSourceParameterValue getDataSourceParameterValuesArray(int i)

Internal Use Only.

isNilDataSourceParameterValuesArray

boolean isNilDataSourceParameterValuesArray(int i)

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

Parameters:

i - the index of the DataSourceParameterValues element

Returns:

true if the DataSourceParameterValues element is nil, otherwise false

sizeOfDataSourceParameterValuesArray

int sizeOfDataSourceParameterValuesArray()

Returns the size of the DataSourceParameterValues array.

Returns:

the size of the DataSourceParameterValues array.

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray)

Sets the array of DataSourceParameterValues element.

Parameters:

dataSourceParameterValuesArray - The array of DataSourceParameterValue

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(int i,
                                       DataSourceParameterValue dataSourceParameterValues)

Sets the DataSourceParameterValues element at the specified index position.

Parameters:

i - the index of the DataSourceParameterValue element

dataSourceParameterValues - The DataSourceParameterValue instance

setNilDataSourceParameterValuesArray

void setNilDataSourceParameterValuesArray(int i)

Sets the DataSourceParameterValues element to nil at the specified index position.

Parameters:

i - the index of the DataSourceParameterValue element

insertNewDataSourceParameterValues

DataSourceParameterValue insertNewDataSourceParameterValues(int i)

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

Parameters:

i - the index of the DataSourceParameterValue element

Returns:

a new empty value as the ith DataSourceParameterValues element

addNewDataSourceParameterValues

DataSourceParameterValue addNewDataSourceParameterValues()

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

Returns:

a new empty value as the last DataSourceParameterValues element

removeDataSourceParameterValues

void removeDataSourceParameterValues(int i)

Removes the DataSourceParameterValues element at the specified index position.

Parameters:

i - the index of the DataSourceParameterValue element

getPromptLOVRetrievalMode

PromptLOVRetrievalMode.Enum getPromptLOVRetrievalMode()

Internal Use Only.

xgetPromptLOVRetrievalMode

PromptLOVRetrievalMode xgetPromptLOVRetrievalMode()

Internal Use Only.

setPromptLOVRetrievalMode

void setPromptLOVRetrievalMode(PromptLOVRetrievalMode.Enum promptLOVRetrievalMode)

Restricts the way List Of Values for Prompts are retrieved.
Example: Set the LOV retrieval mode for prompts.

 String astrSelectedPrompts = new String[1];
 astrSelectedPrompts[0] = docInfo.getPromptInfo(0).getID();
 RetrievePromptsInfo objRetrievePromptsInfo = new RetrievePromptsInfo();
 objRetrievePromptsInfo.setPromptLOVRetrievalMode(PromptLOVRetrievalMode.SELECTED);
 objRetrievePromptsInfo.setRefreshReturnedLOVs(false);
 objRetrievePromptsInfo.setSelectPrompts(astrSelectedPrompts);
 RetrieveMustFillInfo objRetrieveMustFillInfo = new RetrieveMustFillInfo();
 objRetrieveMustFillInfo.setRetrievePromptsInfo(objRetrievePromptsInfo);
 

Parameters:

promptLOVRetrievalMode - - set to the desired retrieval mode.

See Also:

PromptLOVRetrievalMode

xsetPromptLOVRetrievalMode

void xsetPromptLOVRetrievalMode(PromptLOVRetrievalMode promptLOVRetrievalMode)

Internal Use Only.

getRefreshReturnedLOVs

boolean getRefreshReturnedLOVs()

Internal Use Only.

xgetRefreshReturnedLOVs

org.apache.xmlbeans.XmlBoolean xgetRefreshReturnedLOVs()

Internal Use Only.

setRefreshReturnedLOVs

void setRefreshReturnedLOVs(boolean refreshReturnedLOVs)

Set to true if selected List Of Values(LOV) are refreshed before being returned in the DocumentInformation object.

Parameters:

refreshReturnedLOVs - - true if selected List Of Values(LOV) will be refreshed.

xsetRefreshReturnedLOVs

void xsetRefreshReturnedLOVs(org.apache.xmlbeans.XmlBoolean refreshReturnedLOVs)

Internal Use Only.

getReturnLOVOnMustFillPrompts

boolean getReturnLOVOnMustFillPrompts()

Internal Use Only.

xgetReturnLOVOnMustFillPrompts

org.apache.xmlbeans.XmlBoolean xgetReturnLOVOnMustFillPrompts()

Internal Use Only.

setReturnLOVOnMustFillPrompts

void setReturnLOVOnMustFillPrompts(boolean returnLOVOnMustFillPrompts)

Set to true to improve performance by retrieving only necessary prompt information.
Set to true to improve performance by minimizing network traffic with the Web Services server.
If this method is set to false, all List Of Values (LOV) associated to a prompt are retrieved with each selected prompt.
Note: This function only has an effect if DocumentInformation.isMustFillPrompts() returns false.

Note: Business Objects recommends setting this value to true.

Parameters:

returnLOVOnMustFillPrompts - - set to true for improved performance.

xsetReturnLOVOnMustFillPrompts

void xsetReturnLOVOnMustFillPrompts(org.apache.xmlbeans.XmlBoolean returnLOVOnMustFillPrompts)

Internal Use Only.