com.businessobjects.sdk.plugin.desktop.webi
Interface IWebiPrompt

public interface IWebiPrompt

This interface provides methods that allow you to identify the prompt and its associated information for a given Web Intelligence document.

Field Summary

static java.lang.String

SI_DYNAMIC

Method Summary

java.util.List	getDataProviders() Returns a collection of data providers that are with this prompt.
java.lang.String	getName() Returns the name of the prompt.
java.util.List	getValueIndexes() Returns a collection of indexes prompt value currently chosen for this prompt.
java.util.List	getValues() Returns a collection of prompt values currently chosen for this prompt.
java.util.List	getValuesToDisplay()
boolean	isDynamic()
boolean	isSkipped() Returns a boolean which indicate if the prompt could be skipped or not.
void	setDynamic(boolean isDynamic)
void	setSkipped(boolean isSkipped) Sets skipped property on the current prompt, only if the prompt is optional and if no value have been given.

Field Detail

SI_DYNAMIC

static final java.lang.String SI_DYNAMIC

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws SDKException

Returns the name of the prompt.

Returns:

A String that contains the name of the prompt.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isSkipped

boolean isSkipped()
                  throws SDKException

Returns a boolean which indicate if the prompt could be skipped or not.

Returns:

true if the prompt is optional and if no value is given, false otherwise

Throws:

SDKException

setSkipped

void setSkipped(boolean isSkipped)

Sets skipped property on the current prompt, only if the prompt is optional and if no value have been given.

Parameters:

isSkipped -

isDynamic

boolean isDynamic()
                  throws SDKException

Throws:

SDKException

setDynamic

void setDynamic(boolean isDynamic)

getValues

java.util.List getValues()
                         throws SDKException

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

Returns:

A List object that contains the prompt values that have been chosen for this prompt.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getValuesToDisplay

java.util.List getValuesToDisplay()
                                  throws SDKException

Throws:

SDKException

getValueIndexes

java.util.List getValueIndexes()
                               throws SDKException

Returns a collection of indexes prompt value currently chosen for this prompt. Index for a given value is ordered from this collection as in IWebiPrompt.getValues()

Returns:

A List object that contains indexes prompt values that have been chosen for this prompt.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDataProviders

java.util.List getDataProviders()
                                throws SDKException

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

Returns:

A List object that contains the data providers that are associated with this prompt.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IDataProvider