com.businessobjects.dsws.reportengine
Interface QueryContext

public interface QueryContext

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.
The list of QueryContexts that need to be filled to refresh a document is retrieved using DocumentInformation.getQueryContextsArray(). Use the returned QueryContext objects to populate a FillQueryContexts which is sent to the document when it is refreshed. Note: To retrieve the QueryContext, you must pass the Refresh action to the ReportEngine.getDocumentInformation().

Example: Setting the QueryContext.

 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(strDocid,fillInfo,actions,null,null);
 String reference = boDocInfo.getDocumentReference();
 if (boDocInfo.getMustFillQueryContexts())
 {
   QueryContext[] boQueryInfo = boDocInfo.getQueryContextsArray();
   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);
   CharacterView myBOView=(CharacterView)boDocInfo.getView();
   String docContents=myBOView.getContent();
   out.print(docContents);
 }
 

See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

void	addDataProviderIDs(java.lang.String dataProviderIDs) Internal Use Only.
void	addDescription(java.lang.String description) Internal Use Only.
org.apache.xmlbeans.XmlString	addNewDataProviderIDs() Internal Use Only.
org.apache.xmlbeans.XmlString	addNewDescription() Internal Use Only.
org.apache.xmlbeans.XmlString	addNewPreviousValues() Internal Use Only.
org.apache.xmlbeans.XmlString	addNewValues() Internal Use Only.
void	addPreviousValues(java.lang.String previousValues) Internal Use Only.
void	addValues(java.lang.String values) Internal Use Only.
boolean	getAllowMultiValues() Returns true if the specified query context allows to select multiple values, otherwise false.
java.lang.String[]	getDataProviderIDsArray() Gets the data provider IDs.
java.lang.String	getDataProviderIDsArray(int i) Gets the data provider IDs at the specified position.
java.lang.String[]	getDescriptionArray() Returns the description of the query context.
java.lang.String	getDescriptionArray(int i) Gets the description of the query context at the specified position.
java.lang.String	getName() Gets the name of the query context.
java.lang.String[]	getPreviousValuesArray() Returns an array of the values previously attributed to the query context.
java.lang.String	getPreviousValuesArray(int i) Returns the previous value of the query context.
boolean	getRequireAnswers() Returns true if the specified query context requires answer, otherwise false.
java.lang.String	getUID() Gets the UID of the query context
java.lang.String[]	getValuesArray() Returns an array of possible query context values for this QueryContext.
java.lang.String	getValuesArray(int i) Returns one possible query context value for this QueryContext.
void	insertDataProviderIDs(int i, java.lang.String dataProviderIDs) Internal Use Only.
void	insertDescription(int i, java.lang.String description) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewDataProviderIDs(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewDescription(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewPreviousValues(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewValues(int i) Internal Use Only.
void	insertPreviousValues(int i, java.lang.String previousValues) Internal Use Only.
void	insertValues(int i, java.lang.String values) Internal Use Only.
boolean	isNilDataProviderIDsArray(int i) Checks if the DataProviderIDs element is nil at the specified index position.
boolean	isNilDescriptionArray(int i) Checks if the Description element at the specified index position.
boolean	isNilPreviousValuesArray(int i) Checks if the PreviousValues element is nil at the specified index position.
boolean	isNilValuesArray(int i) Checks if the Values element is nil at the specified index position.
void	removeDataProviderIDs(int i) Internal Use Only.
void	removeDescription(int i) Internal Use Only.
void	removePreviousValues(int i) Internal Use Only.
void	removeValues(int i) Internal Use Only.
void	setAllowMultiValues(boolean allowMultiValues) Internal Use Only.
void	setDataProviderIDsArray(int i, java.lang.String dataProviderIDs) Internal Use Only.
void	setDataProviderIDsArray(java.lang.String[] dataProviderIDsArray) Internal Use Only.
void	setDescriptionArray(int i, java.lang.String description) Internal Use Only.
void	setDescriptionArray(java.lang.String[] descriptionArray) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilDataProviderIDsArray(int i) Internal Use Only.
void	setNilDescriptionArray(int i) Internal Use Only.
void	setNilPreviousValuesArray(int i) Internal Use Only.
void	setNilValuesArray(int i) Internal Use Only.
void	setPreviousValuesArray(int i, java.lang.String previousValues) Internal Use Only.
void	setPreviousValuesArray(java.lang.String[] previousValuesArray) Internal Use Only.
void	setRequireAnswers(boolean requireAnswers) Internal Use Only.
void	setUID(java.lang.String uid) Internal Use Only.
void	setValuesArray(int i, java.lang.String values) Internal Use Only.
void	setValuesArray(java.lang.String[] valuesArray) Internal Use Only.
int	sizeOfDataProviderIDsArray() Returns the size of the DataProviderIDs array
int	sizeOfDescriptionArray() Returns the size of the description array
int	sizeOfPreviousValuesArray() Returns the size of the PreviousValues array
int	sizeOfValuesArray() Returns the size of the Values array.
org.apache.xmlbeans.XmlBoolean	xgetAllowMultiValues() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetDataProviderIDsArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDataProviderIDsArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetDescriptionArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescriptionArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetPreviousValuesArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPreviousValuesArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRequireAnswers() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUID() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetValuesArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetValuesArray(int i) Internal Use Only.
void	xsetAllowMultiValues(org.apache.xmlbeans.XmlBoolean allowMultiValues) Internal Use Only.
void	xsetDataProviderIDsArray(int i, org.apache.xmlbeans.XmlString dataProviderIDs) Internal Use Only.
void	xsetDataProviderIDsArray(org.apache.xmlbeans.XmlString[] dataProviderIDsArray) Internal Use Only.
void	xsetDescriptionArray(int i, org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetDescriptionArray(org.apache.xmlbeans.XmlString[] descriptionArray) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetPreviousValuesArray(int i, org.apache.xmlbeans.XmlString previousValues) Internal Use Only.
void	xsetPreviousValuesArray(org.apache.xmlbeans.XmlString[] previousValuesArray) Internal Use Only.
void	xsetRequireAnswers(org.apache.xmlbeans.XmlBoolean requireAnswers) Internal Use Only.
void	xsetUID(org.apache.xmlbeans.XmlString uid) 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()

Returns an array of possible query context values for this QueryContext.

Returns:

an array of Strings containing query context values.

getValuesArray

java.lang.String getValuesArray(int i)

Returns one possible query context value for this QueryContext.

Parameters:

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

Returns:

one possible query context value.

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 size of the Values array.

Returns:

the size of the Values array.

setValuesArray

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

Internal Use Only.

setValuesArray

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

Internal Use Only.

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)

Internal Use Only.

insertValues

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

Internal Use Only.

addValues

void addValues(java.lang.String values)

Internal Use Only.

insertNewValues

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

Internal Use Only.

addNewValues

org.apache.xmlbeans.XmlString addNewValues()

Internal Use Only.

removeValues

void removeValues(int i)

Internal Use Only.

getPreviousValuesArray

java.lang.String[] getPreviousValuesArray()

Returns an array of the values previously attributed to the query context.

Returns:

an array of Strings containing query context values.

getPreviousValuesArray

java.lang.String getPreviousValuesArray(int i)

Returns the previous value of the query context.

Parameters:

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

Returns:

The previous value of the query context.

xgetPreviousValuesArray

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

Internal Use Only.

xgetPreviousValuesArray

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

Internal Use Only.

isNilPreviousValuesArray

boolean isNilPreviousValuesArray(int i)

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

Parameters:

i - the index of the PreviousValues element

Returns:

true if the PreviousValues element is nil, otherwise false.

sizeOfPreviousValuesArray

int sizeOfPreviousValuesArray()

Returns the size of the PreviousValues array

Returns:

the size of the PreviousValues array

setPreviousValuesArray

void setPreviousValuesArray(java.lang.String[] previousValuesArray)

Internal Use Only.

setPreviousValuesArray

void setPreviousValuesArray(int i,
                            java.lang.String previousValues)

Internal Use Only.

xsetPreviousValuesArray

void xsetPreviousValuesArray(org.apache.xmlbeans.XmlString[] previousValuesArray)

Internal Use Only.

xsetPreviousValuesArray

void xsetPreviousValuesArray(int i,
                             org.apache.xmlbeans.XmlString previousValues)

Internal Use Only.

setNilPreviousValuesArray

void setNilPreviousValuesArray(int i)

Internal Use Only.

insertPreviousValues

void insertPreviousValues(int i,
                          java.lang.String previousValues)

Internal Use Only.

addPreviousValues

void addPreviousValues(java.lang.String previousValues)

Internal Use Only.

insertNewPreviousValues

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

Internal Use Only.

addNewPreviousValues

org.apache.xmlbeans.XmlString addNewPreviousValues()

Internal Use Only.

removePreviousValues

void removePreviousValues(int i)

Internal Use Only.

getDescriptionArray

java.lang.String[] getDescriptionArray()

Returns the description of the query context.

Returns:

the description of the query context.

getDescriptionArray

java.lang.String getDescriptionArray(int i)

Gets the description of the query context at the specified position.

Parameters:

i - the index of the Description element

Returns:

the description of the query context at the specified position.

xgetDescriptionArray

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

Internal Use Only.

xgetDescriptionArray

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

Internal Use Only.

isNilDescriptionArray

boolean isNilDescriptionArray(int i)

Checks if the Description element at the specified index position.

Parameters:

i - the index of the Description element

Returns:

true if the Description element is nil, otherwise false.

sizeOfDescriptionArray

int sizeOfDescriptionArray()

Returns the size of the description array

Returns:

the size of the description array

setDescriptionArray

void setDescriptionArray(java.lang.String[] descriptionArray)

Internal Use Only.

setDescriptionArray

void setDescriptionArray(int i,
                         java.lang.String description)

Internal Use Only.

xsetDescriptionArray

void xsetDescriptionArray(org.apache.xmlbeans.XmlString[] descriptionArray)

Internal Use Only.

xsetDescriptionArray

void xsetDescriptionArray(int i,
                          org.apache.xmlbeans.XmlString description)

Internal Use Only.

setNilDescriptionArray

void setNilDescriptionArray(int i)

Internal Use Only.

insertDescription

void insertDescription(int i,
                       java.lang.String description)

Internal Use Only.

addDescription

void addDescription(java.lang.String description)

Internal Use Only.

insertNewDescription

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

Internal Use Only.

addNewDescription

org.apache.xmlbeans.XmlString addNewDescription()

Internal Use Only.

removeDescription

void removeDescription(int i)

Internal Use Only.

getDataProviderIDsArray

java.lang.String[] getDataProviderIDsArray()

Gets the data provider IDs.

Returns:

the array of data provider IDs.

getDataProviderIDsArray

java.lang.String getDataProviderIDsArray(int i)

Gets the data provider IDs at the specified position.

Parameters:

the - index of the data provider ID to be retrieved.

Returns:

the data provider IDs at the specified position.

xgetDataProviderIDsArray

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

Internal Use Only.

xgetDataProviderIDsArray

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

Internal Use Only.

isNilDataProviderIDsArray

boolean isNilDataProviderIDsArray(int i)

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

Parameters:

i - the index of the DataProviderIDs element

Returns:

true if the DataProviderIDs element is nil, otherwise false.

sizeOfDataProviderIDsArray

int sizeOfDataProviderIDsArray()

Returns the size of the DataProviderIDs array

Returns:

the size of the DataProviderIDs array

setDataProviderIDsArray

void setDataProviderIDsArray(java.lang.String[] dataProviderIDsArray)

Internal Use Only.

setDataProviderIDsArray

void setDataProviderIDsArray(int i,
                             java.lang.String dataProviderIDs)

Internal Use Only.

xsetDataProviderIDsArray

void xsetDataProviderIDsArray(org.apache.xmlbeans.XmlString[] dataProviderIDsArray)

Internal Use Only.

xsetDataProviderIDsArray

void xsetDataProviderIDsArray(int i,
                              org.apache.xmlbeans.XmlString dataProviderIDs)

Internal Use Only.

setNilDataProviderIDsArray

void setNilDataProviderIDsArray(int i)

Internal Use Only.

insertDataProviderIDs

void insertDataProviderIDs(int i,
                           java.lang.String dataProviderIDs)

Internal Use Only.

addDataProviderIDs

void addDataProviderIDs(java.lang.String dataProviderIDs)

Internal Use Only.

insertNewDataProviderIDs

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

Internal Use Only.

addNewDataProviderIDs

org.apache.xmlbeans.XmlString addNewDataProviderIDs()

Internal Use Only.

removeDataProviderIDs

void removeDataProviderIDs(int i)

Internal Use Only.

getName

java.lang.String getName()

Gets the name of the query context.

Returns:

the name of the query context

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getRequireAnswers

boolean getRequireAnswers()

Returns true if the specified query context requires answer, otherwise false.

Returns:

true if the specified query context requires answer, otherwise false.

xgetRequireAnswers

org.apache.xmlbeans.XmlBoolean xgetRequireAnswers()

Internal Use Only.

setRequireAnswers

void setRequireAnswers(boolean requireAnswers)

Internal Use Only.

xsetRequireAnswers

void xsetRequireAnswers(org.apache.xmlbeans.XmlBoolean requireAnswers)

Internal Use Only.

getAllowMultiValues

boolean getAllowMultiValues()

Returns true if the specified query context allows to select multiple values, otherwise false.

Returns:

true if the specified query context allows to select multiple values, otherwise false.

xgetAllowMultiValues

org.apache.xmlbeans.XmlBoolean xgetAllowMultiValues()

Internal Use Only.

setAllowMultiValues

void setAllowMultiValues(boolean allowMultiValues)

Internal Use Only.

xsetAllowMultiValues

void xsetAllowMultiValues(org.apache.xmlbeans.XmlBoolean allowMultiValues)

Internal Use Only.

getUID

java.lang.String getUID()

Gets the UID of the query context

Returns:

the UID of the query context

xgetUID

org.apache.xmlbeans.XmlString xgetUID()

Internal Use Only.

setUID

void setUID(java.lang.String uid)

Internal Use Only.

xsetUID

void xsetUID(org.apache.xmlbeans.XmlString uid)

Internal Use Only.