com.businessobjects.enterprise.webi
Interface WebiPrompt

public interface WebiPrompt

Provides properties that allow you to identify the prompt and its associated information for a given Web Intelligence document.

A prompt can appear whenever a user executes a query that contains an object with either a user-defined condition, or a predefined condition set by the designer of the universe.

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DataProviders	addNewDataProviders() Appends and returns a new empty DataProviders object.
Indexes	addNewIndexes() Appends and returns a new empty Indexes object.
Values	addNewValues() Appends and returns a new empty Values object.
DataProviders	getDataProviders() Returns a collection of data providers that are associated with this prompt.
Indexes	getIndexes() Returns the Indexes.
java.lang.String	getName() Returns the name of the prompt.
Values	getValues() Returns a collection of prompt values currently chosen for this prompt.
boolean	isSetDataProviders() Checks if the collection of data providers has been set.
boolean	isSetIndexes() Checks if the Indexes element has been set.
boolean	isSetValues() Checks if the collection of prompt values has been set.
void	setDataProviders(DataProviders dataProviders) Sets a collection of data providers currently chosen for this prompt.
void	setIndexes(Indexes indexes) Sets the Indexes.
void	setName(java.lang.String name) Internal Use Only.
void	setValues(Values values) Sets a collection of prompt values currently chosen for this prompt.
void	unsetDataProviders() Deletes or unsets the DataProviders element.
void	unsetIndexes() Deletes or unsets the Indexes element.
void	unsetValues() Deletes or unsets the Values element.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getName

java.lang.String getName()

Returns the name of the prompt.

Returns:

A String that contains the name of the prompt.

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.

getValues

Values getValues()

Returns a collection of prompt values currently chosen for this prompt.

Returns:

A collection of prompt values.

isSetValues

boolean isSetValues()

Checks if the collection of prompt values has been set.

Returns:

true if the Values element has been set, and false otherwise.

setValues

void setValues(Values values)

Sets a collection of prompt values currently chosen for this prompt.

Parameters:

values - A collection of prompt values.

addNewValues

Values addNewValues()

Appends and returns a new empty Values object.

Returns:

An empty Values object.

unsetValues

void unsetValues()

Deletes or unsets the Values element.

getIndexes

Indexes getIndexes()

Returns the Indexes.

Returns:

The Indexes.

isSetIndexes

boolean isSetIndexes()

Checks if the Indexes element has been set.

Returns:

true if the Indexes element has been set, and false otherwise.

setIndexes

void setIndexes(Indexes indexes)

Sets the Indexes.

Parameters:

indexes - The indexes.

addNewIndexes

Indexes addNewIndexes()

Appends and returns a new empty Indexes object.

Returns:

An empty Indexes object.

unsetIndexes

void unsetIndexes()

Deletes or unsets the Indexes element.

getDataProviders

DataProviders getDataProviders()

Returns a collection of data providers that are associated with this prompt.

Returns:

A collection of data providers that are associated with this prompt.

isSetDataProviders

boolean isSetDataProviders()

Checks if the collection of data providers has been set.

Returns:

true if the DataProviders element has been set, and false otherwise.

setDataProviders

void setDataProviders(DataProviders dataProviders)

Sets a collection of data providers currently chosen for this prompt.

Parameters:

dataProviders - A collection of data providers.

addNewDataProviders

DataProviders addNewDataProviders()

Appends and returns a new empty DataProviders object.

Returns:

An empty DataProviders object.

unsetDataProviders

void unsetDataProviders()

Deletes or unsets the DataProviders element.