com.businessobjects.dsws.reportengine
Interface FillQueryContext

public interface FillQueryContext

A QueryContext is used to resolve context prompting that may appear during document refresh.
A Context is used to avoid ambiguity when defining a query.
To retrieve a list of QueryContext needed to resolve context prompting a RetrieveQueryContext object must be added to the RetrieveMustFillInfo object passed to ReportEngine.getDocumentInformation.

Example: Retrieve a documents QueryContexts.

 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrieveQueryContext queryContextInfo = RetrieveQueryContext.Factory.newInstance();
 fillInfo.setRetrieveQueryContext(queryContextInfo);
 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(docid,fillInfo,actions,null,null);
 if (boDocInfo.getMustFillQueryContexts())
 {
                QueryContext[] boQueryInfo = boDocInfo.getQueryContextsArray();
 }
 

Example: Set the list of QueryContexts to be sent to a document.

 FillQueryContexts boQueryContext = FillQueryContexts.Factory.newInstance();
 FillQueryContext[] fillQueryContext=new FillQueryContext[1];
 fillQueryContext[0] = FillQueryContext.Factory.newInstance();
 fillQueryContext[0].setID(boQueryInfo[0].getUID());
 String[] strValue = {"Reservations"};
 fillQueryContext[0].setValuesArray(strValue);
 boQueryContext.setFillQueryContextListArray(fillQueryContext);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOData.setRetrieveView(retBOView);
 actions[0]= boQueryContext;
 boDocInfo = boRepEng.getDocumentInformation(reference,fillInfo,actions,null,retBOData);
 

See Also:

QueryContext, FillQueryContext, FillQueryContexts, QueryContext, RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

org.apache.xmlbeans.XmlString	addNewValues() Appends and returns a new empty value as the last Values element
void	addValues(java.lang.String values) Appends the value as the last Values element.
java.lang.String	getID() Internal Use Only.
java.lang.String[]	getValuesArray() Internal Use Only.
java.lang.String	getValuesArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewValues(int i) Inserts and returns a new empty value as the ith Values element
void	insertValues(int i, java.lang.String values) Inserts the Values element at the specified index position.
boolean	isNilValuesArray(int i) Checks if the Values" element is nil at the specified index position.
void	removeValues(int i) Removes the Values element at the specified index position.
void	setID(java.lang.String id) Sets the query context ID.
void	setNilValuesArray(int i) Checks if the Values element is nil at the specified index position.
void	setValuesArray(int i, java.lang.String values) Sets a single query context value in the array of values.
void	setValuesArray(java.lang.String[] valuesArray) Sets the array of strings containing query context values to be passed to the document when it is refreshed.
int	sizeOfValuesArray() Returns the number of Values element.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetValuesArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetValuesArray(int i) Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.
void	xsetValuesArray(int i, org.apache.xmlbeans.XmlString values) Internal Use Only.
void	xsetValuesArray(org.apache.xmlbeans.XmlString[] valuesArray) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getValuesArray

java.lang.String[] getValuesArray()

Internal Use Only.

getValuesArray

java.lang.String getValuesArray(int i)

Internal Use Only.

xgetValuesArray

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

Internal Use Only.

xgetValuesArray

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

Internal Use Only.

isNilValuesArray

boolean isNilValuesArray(int i)

Checks if the Values" element is nil at the specified index position.

Parameters:

i - the index of the Values element

Returns:

true if the Values element is nil, otherwise false

sizeOfValuesArray

int sizeOfValuesArray()

Returns the number of Values element.

Returns:

the size of the Values array

setValuesArray

void setValuesArray(java.lang.String[] valuesArray)

Sets the array of strings containing query context values to be passed to the document when it is refreshed.

Parameters:

values - An array of strings containing query context values.

See Also:

FillQueryContext, FillQueryContexts, QueryContext, RetrieveView, RetrieveData, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine

setValuesArray

void setValuesArray(int i,
                    java.lang.String values)

Sets a single query context value in the array of values.

Note: Before using this function, #setValues(java.lang.String[] values) has to be called to initialize the array.

Parameters:

i - The index of the query context value to be set.

value - A single query context value.

See Also:

FillQueryContext, FillQueryContexts, QueryContext, RetrieveView, RetrieveData, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine

xsetValuesArray

void xsetValuesArray(org.apache.xmlbeans.XmlString[] valuesArray)

Internal Use Only.

xsetValuesArray

void xsetValuesArray(int i,
                     org.apache.xmlbeans.XmlString values)

Internal Use Only.

setNilValuesArray

void setNilValuesArray(int i)

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

Parameters:

i - the index of the Values element

insertValues

void insertValues(int i,
                  java.lang.String values)

Inserts the Values element at the specified index position.

Parameters:

i - the index of the Values element.

values - the String value of Value element.

addValues

void addValues(java.lang.String values)

Appends the value as the last Values element.

Parameters:

values - the String value of Value element.

insertNewValues

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

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

Parameters:

i - the index of the Values element

Returns:

a new empty value as the ith Values element

addNewValues

org.apache.xmlbeans.XmlString addNewValues()

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

Returns:

a new empty value as the last Values element

removeValues

void removeValues(int i)

Removes the Values element at the specified index position.

Parameters:

i - the index of the Values element

getID

java.lang.String getID()

Internal Use Only.

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Sets the query context ID.

Parameters:

ID - the query context ID.

See Also:

FillQueryContext, FillQueryContexts, QueryContext, RetrieveView, RetrieveData, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.