com.businessobjects.enterprise.fullclient
Interface FullClientPrompts

public interface FullClientPrompts

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

FullClientPrompt	addNewPrompt() Appends and returns a new empty FullClientPrompt object to the last element of the array.
FullClientPrompt[]	getPromptArray() Returns the array of FullClientPrompt objects.
FullClientPrompt	getPromptArray(int i) Returns the FullClientPrompt object at the specified index position.
FullClientPrompt	insertNewPrompt(int i) Inserts and returns a new empty value (as xml) of the Prompt element at the spcecified index position.
void	removePrompt(int i) Removes the BusinessView ID at the specified index position.
void	setPromptArray(FullClientPrompt[] promptArray) Sets the array of FullClientPrompt objects.
void	setPromptArray(int i, FullClientPrompt prompt) Sets the FullClientPrompt object at the specified index position.
int	sizeOfPromptArray() Returns the Size of the PromptArray.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getPromptArray

FullClientPrompt[] getPromptArray()

Returns the array of FullClientPrompt objects.

Returns:

The array of FullClientPrompt objects.

getPromptArray

FullClientPrompt getPromptArray(int i)

Returns the FullClientPrompt object at the specified index position.

Parameters:

i - The index position.

Returns:

The FullClientPrompt object.

sizeOfPromptArray

int sizeOfPromptArray()

Returns the Size of the PromptArray.

Returns:

The size of the array.

setPromptArray

void setPromptArray(FullClientPrompt[] promptArray)

Sets the array of FullClientPrompt objects.

Parameters:

promptArray - The array of FullClientPrompt objects.

setPromptArray

void setPromptArray(int i,
                    FullClientPrompt prompt)

Sets the FullClientPrompt object at the specified index position.

Parameters:

i - The index position.

prompt - The FullClientPrompt object.

insertNewPrompt

FullClientPrompt insertNewPrompt(int i)

Inserts and returns a new empty value (as xml) of the Prompt element at the spcecified index position.

Parameters:

i - The index position

Returns:

a new empty value (as xml) of the Prompt element at the spcecified index position.

addNewPrompt

FullClientPrompt addNewPrompt()

Appends and returns a new empty FullClientPrompt object to the last element of the array.

Returns:

A new FullClientPrompt.

removePrompt

void removePrompt(int i)

Removes the BusinessView ID at the specified index position.

Parameters:

i - The index position to remove the BusinessView ID.