com.businessobjects.dsws.reportengine
Interface FillQueryContexts

All Superinterfaces:

Action

public interface FillQueryContexts
extends Action

FillQueryContexts holds an array of FillQueryContext objects used to resolve context prompting that may appear during document refresh.
A Context is used to avoid ambiguity when defining a query.

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

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

FillQueryContext	addNewFillQueryContextList() Appends and returns a new empty value as the last FillQueryContextList element
FillQueryContext[]	getFillQueryContextListArray() Internal Use Only.
FillQueryContext	getFillQueryContextListArray(int i) Internal Use Only.
FillQueryContext	insertNewFillQueryContextList(int i) Inserts and returns a new empty value as the ith FillQueryContextList element
boolean	isNilFillQueryContextListArray(int i) Checks if the FillQueryContextList element is nil at the specified index position.
void	removeFillQueryContextList(int i) Removes the FillQueryContextList element at the specified index position.
void	setFillQueryContextListArray(FillQueryContext[] fillQueryContextListArray) Sets the array of FillQueryContext objects needed by a document.
void	setFillQueryContextListArray(int i, FillQueryContext fillQueryContextList) Sets the FillQueryContext object at the specified index position..
void	setNilFillQueryContextListArray(int i) Sets the FillQueryContextList element to nil at the specified index location.
int	sizeOfFillQueryContextListArray() Returns the number of FillQueryContextList element.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getFillQueryContextListArray

FillQueryContext[] getFillQueryContextListArray()

Internal Use Only.

getFillQueryContextListArray

FillQueryContext getFillQueryContextListArray(int i)

Internal Use Only.

isNilFillQueryContextListArray

boolean isNilFillQueryContextListArray(int i)

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

Parameters:

i - the index of the FillQueryContextList element

sizeOfFillQueryContextListArray

int sizeOfFillQueryContextListArray()

Returns the number of FillQueryContextList element.

Returns:

the size of the FillQueryContextList element.

setFillQueryContextListArray

void setFillQueryContextListArray(FillQueryContext[] fillQueryContextListArray)

Sets the array of FillQueryContext objects needed by a document.

Parameters:

fillQueryContextList - an array of FillQueryContext objects.

setFillQueryContextListArray

void setFillQueryContextListArray(int i,
                                  FillQueryContext fillQueryContextList)

Sets the FillQueryContext object at the specified index position..

Note: Before using this function, #setFillQueryContextList(com.businessobjects.dsws.reportengine.FillQueryContext[] fillQueryContextList) has to be called to initialize the array.

Parameters:

i - The index of the FillQueryContext to be set.

value - a single FillQueryContext object.

setNilFillQueryContextListArray

void setNilFillQueryContextListArray(int i)

Sets the FillQueryContextList element to nil at the specified index location.

Parameters:

i - the index of the FillQueryContextList element.

insertNewFillQueryContextList

FillQueryContext insertNewFillQueryContextList(int i)

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

Parameters:

i - the index of the FillQueryContextList element

Returns:

a new empty value as the ith FillQueryContextList element

addNewFillQueryContextList

FillQueryContext addNewFillQueryContextList()

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

Returns:

a new empty value as the last FillQueryContextList element

removeFillQueryContextList

void removeFillQueryContextList(int i)

Removes the FillQueryContextList element at the specified index position.

Parameters:

i - the index of the FillQueryContextList element