com.businessobjects.enterprise.webi
Interface WebiPrompts

public interface WebiPrompts

A collection of prompts that are associated with this Web Intelligence document.

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

WebiPrompt	addNewPrompt() Appends and returns a new empty WebiPrompt object as the last element of the array.
WebiPrompt[]	getPromptArray() Returns the array of WebiPrompt objects.
WebiPrompt	getPromptArray(int i) Returns the WebiPrompt object at the specified index position.
WebiPrompt	insertNewPrompt(int i) Inserts and returns a new empty WebiPrompt object at a specified index.
void	removePrompt(int i) Removes the ith WebiPrompt object.
void	setPromptArray(int i, WebiPrompt prompt) Sets the WebiPrompt object as the ith object of the array.
void	setPromptArray(WebiPrompt[] promptArray) Sets the array of WebiPrompt objects.
int	sizeOfPromptArray() Returns number of WebiPrompt objects in the array.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getPromptArray

WebiPrompt[] getPromptArray()

Returns the array of WebiPrompt objects.

Returns:

The array of WebiPrompt objects.

getPromptArray

WebiPrompt getPromptArray(int i)

Returns the WebiPrompt object at the specified index position.

Parameters:

i - The index position.

Returns:

The WebiPrompt object.

sizeOfPromptArray

int sizeOfPromptArray()

Returns number of WebiPrompt objects in the array.

Returns:

The size of the WebiPrompt array.

setPromptArray

void setPromptArray(WebiPrompt[] promptArray)

Sets the array of WebiPrompt objects.

Parameters:

promptArray - The array of WebiPrompt objects.

setPromptArray

void setPromptArray(int i,
                    WebiPrompt prompt)

Sets the WebiPrompt object as the ith object of the array.

Parameters:

i - The index position to insert the object.

prompt - The WebiPrompt object to be inserted.

insertNewPrompt

WebiPrompt insertNewPrompt(int i)

Inserts and returns a new empty WebiPrompt object at a specified index.

Parameters:

i - The index position to insert the object.

Returns:

The new WebiPrompt object.

addNewPrompt

WebiPrompt addNewPrompt()

Appends and returns a new empty WebiPrompt object as the last element of the array.

Returns:

A new WebiPrompt object.

removePrompt

void removePrompt(int i)

Removes the ith WebiPrompt object.

Parameters:

i - The index position for the object to be removed.