com.businessobjects.dsws.reportengine
Interface Refresh

All Superinterfaces:

Action

public interface Refresh
extends Action

The refresh action is used to refresh data in a document.

Example: Refresh a document.

Action[] actions = new Action[1];
actions[0] = Refresh.Factory.newInstance();
DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strDocid, null, actions, null, null);


See Also:

BICatalog, Document, ReportEngine, DocumentInformation, RetrieveMustFillInfo, Refresh, FillPrompts, Drill, FillPassword, EmbeddedAction, FillDBLogons, FillQueryContext, Navigate, RetrieveData

Nested Class Summary

static class

Refresh.Factory A class with methods for creating instances of the Refresh 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
DataSourceParameterValue[]	getDataSourceParameterValuesArray() Internal use only
DataSourceParameterValue	getDataSourceParameterValuesArray(int i) Internal use only
DataSourceParameterValue	insertNewDataSourceParameterValues(int i) Inserts and returns a new empty value as the ith DataSourceParameterValues element
boolean	isNilDataSourceParameterValuesArray(int i) Checks if the DataSourceParameterValues element is nil at the specified index position.
void	removeDataSourceParameterValues(int i) Removes the DataSourceParameterValues element from the specified index position.
void	setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray) Sets the array of DataSourceParameterValues element to Refresh object.
void	setDataSourceParameterValuesArray(int i, DataSourceParameterValue dataSourceParameterValues) Sets the DataSourceParameterValues element.
void	setNilDataSourceParameterValuesArray(int i) Sets the DataSourceParameterValues element at the specified index position.
int	sizeOfDataSourceParameterValuesArray() Returns the size of the DataSourceParameterValue array

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

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 DataSourceParameterValue element

Returns:

true if the DataSourceParameterValue element is nil, otherwise false

sizeOfDataSourceParameterValuesArray

int sizeOfDataSourceParameterValuesArray()

Returns the size of the DataSourceParameterValue array

Returns:

the size of the DataSourceParameterValue array

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray)

Sets the array of DataSourceParameterValues element to Refresh object.

Parameters:

dataSourceParameterValuesArray - the array of DataSourceParameterValue elements

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(int i,
                                       DataSourceParameterValue dataSourceParameterValues)

Sets the DataSourceParameterValues element.

Parameters:

i - the index of the DataSourceParameterValue element

dataSourceParameterValues - the DataSourceParameterValue object

setNilDataSourceParameterValuesArray

void setNilDataSourceParameterValuesArray(int i)

Sets the DataSourceParameterValues element 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 from the specified index position.

Parameters:

i - the index of the DataSourceParameterValue element