com.businessobjects.dsws.reportengine
Interface PromptInfo

public interface PromptInfo

The PromptInfo interface is used to resolve the prompting that appears during query refresh.
Depending on the properties of the prompt, values can be entered from the List Of Values, manually, or both.
Prompts can have more than one value.
Prompts must be filled each time a document is refreshed.

Example: Retrieve the list of prompts used by the document.

 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrievePromptsInfo promptInfo = RetrievePromptsInfo.Factory.newInstance();
 fillInfo.setRetrievePromptsInfo(promptInfo);

 Action[] actions = new Action[1];
 // Add a Refresh action to the Action array.
 actions[0] = Refresh.Factory.newInstance();
 // Obtain a DocumentInformation object from the ReportEngine.
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(strDocid,fillInfo,actions,null,null);
 if (boDocInfo.getMustFillPrompts())
 {
   PromptInfo[] boPromptInfo = boDocInfo.getPromptInfoArray();
 }
 

See Also:

RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

void	addDataProviderIDs(java.lang.String dataProviderIDs) Internal Use Only.
org.apache.xmlbeans.XmlString	addNewDataProviderIDs() Internal Use Only.
PromptValue	addNewDefaultValues() Internal Use Only.
LOV	addNewLOV() Internal Use Only.
PromptValue	addNewMaxValue() Appends and returns a new empty MaxValue element
PromptValue	addNewMinValue() Appends and returns a new empty MinValue element.
PromptValue	addNewPreviousValues() Internal Use Only.
PromptInfo	addNewPromptToBeFilled() Internal Use Only.
org.apache.xmlbeans.XmlString	addNewPromptValueFormat() Internal Use Only.
void	addPromptValueFormat(java.lang.String promptValueFormat) Internal Use Only.
boolean	getAllowDiscreteValue() Returns true, if this prompt is allowed to take one or more DiscretePromptValue objects.
boolean	getAllowMultiValues() Returns true, if this prompt is allowed multiple values.
boolean	getAllowNonLeafValues() Returns true if the value is at root level, otherwise false.
boolean	getAllowRangeValue() Returns true, if this prompt is allowed to take one or more RangePromptValue objects.
boolean	getConstrained() Returns true, if the user fills a prompt with a value from a List Of Values.
java.lang.String[]	getDataProviderIDsArray() Returns an array of data provider IDs.
java.lang.String	getDataProviderIDsArray(int i) Returns the data provider ID at the specified index position.
PromptValue[]	getDefaultValuesArray() Returns an array containing the default values for this prompt.
PromptValue	getDefaultValuesArray(int i) Returns the default values for this prompt.at the specified index position.
java.lang.String	getDescription() Returns a description of the prompt.
boolean	getHasLOV() Returns true, if this prompt has an associated List Of Values.
java.lang.String	getID() Returns the prompt ID.
java.lang.String	getLocalizedQuestion() Returns the translated question.
LOV	getLOV() Returns the List Of Values associated with this prompt.
boolean	getLovDelegated() Returns true, if this LOV is delegated Example: Check whether LOVs are delegated or not LOVSearch objLOVSearch = LOVSearch.Factory.newInstance(); objLOVSearch.setPattern("*a"); objLOVSearch.setCaseSensitive(true); RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance(); RetrievePromptsInfo promptInfo = RetrievePromptsInfo.Factory.newInstance(); promptInfo.setPromptLOVRetrievalMode(PromptLOVRetrievalMode.ALL); promptInfo.setRefreshReturnedLOVs(true); promptInfo.setReturnLOVOnMustFillPrompts(false); promptInfo.setLOVSearch(objLOVSearch); fillInfo.setRetrievePromptsInfo(promptInfo); Action[] actions = new Action[1]; // Add a Refresh action to the Action array.
LovDisplayType.Enum	getLovDisplayType() Returns the display type of the LOV.
PromptValue	getMaxValue() Returns the maximum value possible for this prompt.
PromptValue	getMinValue() Returns the minimum value possible for this prompt.
java.lang.String	getName() Returns the name of the prompt.
boolean	getOptional() Returns true, if this prompt is optional one.
PromptValue[]	getPreviousValuesArray() Returns an array containing values selected on the last document refresh.
PromptValue	getPreviousValuesArray(int i) Returns one of value selected on the last document refresh.
PromptInfo[]	getPromptToBeFilledArray() Gets the array of PromptToBeFilled elements.
PromptInfo	getPromptToBeFilledArray(int i) Gets the PromptToBeFilled element at the specified index position.
PromptType.Enum	getPromptType() Returns the type of values the prompt takes.
java.lang.String[]	getPromptValueFormatArray() Returns an array of strings containing possible formats for the prompt value.
java.lang.String	getPromptValueFormatArray(int i) Returns a possible format for the prompt value.
boolean	getRequireAnswers() Returns true, if the prompt has to be filled.
void	insertDataProviderIDs(int i, java.lang.String dataProviderIDs) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewDataProviderIDs(int i) Internal Use Only.
PromptValue	insertNewDefaultValues(int i) Internal Use Only.
PromptValue	insertNewPreviousValues(int i) Internal Use Only.
PromptInfo	insertNewPromptToBeFilled(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewPromptValueFormat(int i) Internal Use Only.
void	insertPromptValueFormat(int i, java.lang.String promptValueFormat) Internal Use Only.
boolean	isNilDataProviderIDsArray(int i) Checks if the DataProviderIDs element is nil at the specified index position.
boolean	isNilDefaultValuesArray(int i) Checks if the DefaultValues element is nil at the specified index position.
boolean	isNilDescription() Checks if the Description element is set.
boolean	isNilLOV() Checks if the LOV element is nil.
boolean	isNilLovDisplayType() Checks if the LovDisplayType element is nil.
boolean	isNilMaxValue() Checks if the MaxValue element is nil.
boolean	isNilMinValue() Checks if the MinValue element is nil.
boolean	isNilPreviousValuesArray(int i) Checks if the PreviousValues element is nil at the specified index position.
boolean	isNilPromptToBeFilledArray(int i) Checks if the PromptToBeFilled element is nil at the specified index position.
boolean	isNilPromptValueFormatArray(int i) Checks if the PromptValueFormat element is nil at the specified index position.
boolean	isSetDescription() Checks if the Description element is set.
boolean	isSetLOV() Checks if the LOV element is set.
boolean	isSetMaxValue() Checks if the MaxValue element is set.
boolean	isSetMinValue() Checks if the MinValue element is set.
boolean	isSetOptional() Checks if the Optional attribute is set.
void	removeDataProviderIDs(int i) Internal Use Only.
void	removeDefaultValues(int i) Internal Use Only.
void	removePreviousValues(int i) Internal Use Only.
void	removePromptToBeFilled(int i) Internal Use Only.
void	removePromptValueFormat(int i) Internal Use Only.
void	setAllowDiscreteValue(boolean allowDiscreteValue) Internal Use Only.
void	setAllowMultiValues(boolean allowMultiValues) Internal Use Only.
void	setAllowNonLeafValues(boolean allowNonLeafValues) Internal Use Only.
void	setAllowRangeValue(boolean allowRangeValue) Internal Use Only.
void	setConstrained(boolean constrained) Internal Use Only.
void	setDataProviderIDsArray(int i, java.lang.String dataProviderIDs) Internal Use Only.
void	setDataProviderIDsArray(java.lang.String[] dataProviderIDsArray) Internal Use Only.
void	setDefaultValuesArray(int i, PromptValue defaultValues) Internal Use Only.
void	setDefaultValuesArray(PromptValue[] defaultValuesArray) Internal Use Only.
void	setDescription(java.lang.String description) Internal Use Only.
void	setHasLOV(boolean hasLOV) Internal Use Only.
void	setID(java.lang.String id) Internal Use Only.
void	setLocalizedQuestion(java.lang.String localizedQuestion) Internal use only
void	setLOV(LOV lov) Internal Use Only.
void	setLovDelegated(boolean lovDelegated) Internal Use Only.
void	setLovDisplayType(LovDisplayType.Enum lovDisplayType) Internal Use Only.
void	setMaxValue(PromptValue maxValue) Internal Use Only.
void	setMinValue(PromptValue minValue) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilDataProviderIDsArray(int i) Internal Use Only.
void	setNilDefaultValuesArray(int i) Internal Use Only.
void	setNilDescription() Internal Use Only.
void	setNilLOV() Internal Use Only.
void	setNilLovDisplayType() Internal Use Only.
void	setNilMaxValue() Internal Use Only.
void	setNilMinValue() Internal Use Only.
void	setNilPreviousValuesArray(int i) Internal Use Only.
void	setNilPromptToBeFilledArray(int i) Internal Use Only.
void	setNilPromptValueFormatArray(int i) Internal Use Only.
void	setOptional(boolean optional) Internal Use Only.
void	setPreviousValuesArray(int i, PromptValue previousValues) Internal Use Only.
void	setPreviousValuesArray(PromptValue[] previousValuesArray) Internal Use Only.
void	setPromptToBeFilledArray(int i, PromptInfo promptToBeFilled) Internal Use Only.
void	setPromptToBeFilledArray(PromptInfo[] promptToBeFilledArray) Internal Use Only.
void	setPromptType(PromptType.Enum promptType) Internal Use Only.
void	setPromptValueFormatArray(int i, java.lang.String promptValueFormat) Internal Use Only.
void	setPromptValueFormatArray(java.lang.String[] promptValueFormatArray) Internal Use Only.
void	setRequireAnswers(boolean requireAnswers) Internal Use Only.
int	sizeOfDataProviderIDsArray() Returns the size of the DataProviderIDs array
int	sizeOfDefaultValuesArray() Returns the size of DefaultValues array.
int	sizeOfPreviousValuesArray() Returns the size of the PreviousValues array.
int	sizeOfPromptToBeFilledArray() Returns the size of the PromptToBeFilled array
int	sizeOfPromptValueFormatArray() Returns the size of the PromptvalueFormat array.
void	unsetDescription() Internal Use Only.
void	unsetLOV() Internal Use Only.
void	unsetMaxValue() Internal Use Only.
void	unsetMinValue() Internal Use Only.
void	unsetOptional() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowDiscreteValue() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowMultiValues() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowNonLeafValues() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowRangeValue() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetConstrained() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetDataProviderIDsArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDataProviderIDsArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetHasLOV() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetLocalizedQuestion() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetLovDelegated() Internal Use Only.
LovDisplayType	xgetLovDisplayType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetOptional() Internal Use Only.
PromptType	xgetPromptType() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetPromptValueFormatArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPromptValueFormatArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRequireAnswers() Internal Use Only.
void	xsetAllowDiscreteValue(org.apache.xmlbeans.XmlBoolean allowDiscreteValue) Internal Use Only.
void	xsetAllowMultiValues(org.apache.xmlbeans.XmlBoolean allowMultiValues) Internal Use Only.
void	xsetAllowNonLeafValues(org.apache.xmlbeans.XmlBoolean allowNonLeafValues) Internal Use Only.
void	xsetAllowRangeValue(org.apache.xmlbeans.XmlBoolean allowRangeValue) Internal Use Only.
void	xsetConstrained(org.apache.xmlbeans.XmlBoolean constrained) Internal Use Only.
void	xsetDataProviderIDsArray(int i, org.apache.xmlbeans.XmlString dataProviderIDs) Internal Use Only.
void	xsetDataProviderIDsArray(org.apache.xmlbeans.XmlString[] dataProviderIDsArray) Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetHasLOV(org.apache.xmlbeans.XmlBoolean hasLOV) Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.
void	xsetLocalizedQuestion(org.apache.xmlbeans.XmlString localizedQuestion) Internal use only
void	xsetLovDelegated(org.apache.xmlbeans.XmlBoolean lovDelegated) Internal Use Only.
void	xsetLovDisplayType(LovDisplayType lovDisplayType) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetOptional(org.apache.xmlbeans.XmlBoolean optional) Internal Use Only.
void	xsetPromptType(PromptType promptType) Internal Use Only.
void	xsetPromptValueFormatArray(int i, org.apache.xmlbeans.XmlString promptValueFormat) Internal Use Only.
void	xsetPromptValueFormatArray(org.apache.xmlbeans.XmlString[] promptValueFormatArray) Internal Use Only.
void	xsetRequireAnswers(org.apache.xmlbeans.XmlBoolean requireAnswers) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDescription

java.lang.String getDescription()

Returns a description of the prompt.

Returns:

A description of the prompt.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isNilDescription

boolean isNilDescription()

Checks if the Description element is set.

Returns:

true if the Description element is nil, otherwise false

isSetDescription

boolean isSetDescription()

Checks if the Description element is set.

Returns:

true if the Description element is set, otherwise false

setDescription

void setDescription(java.lang.String description)

Internal Use Only.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

setNilDescription

void setNilDescription()

Internal Use Only.

unsetDescription

void unsetDescription()

Internal Use Only.

getDefaultValuesArray

PromptValue[] getDefaultValuesArray()

Returns an array containing the default values for this prompt.

Returns:

An array of PromptValue.

getDefaultValuesArray

PromptValue getDefaultValuesArray(int i)

Returns the default values for this prompt.at the specified index position.

Parameters:

i - The index of the PromptValue to be retrieved.

Returns:

A single PromptValue.

isNilDefaultValuesArray

boolean isNilDefaultValuesArray(int i)

Checks if the DefaultValues element is nil at the specified index position.

Parameters:

i - the index of the DefaultValues element

Returns:

true if the DefaultValues element is nil, otherwise false

sizeOfDefaultValuesArray

int sizeOfDefaultValuesArray()

Returns the size of DefaultValues array.

Returns:

the size of the DefaultValues array

setDefaultValuesArray

void setDefaultValuesArray(PromptValue[] defaultValuesArray)

Internal Use Only.

setDefaultValuesArray

void setDefaultValuesArray(int i,
                           PromptValue defaultValues)

Internal Use Only.

setNilDefaultValuesArray

void setNilDefaultValuesArray(int i)

Internal Use Only.

insertNewDefaultValues

PromptValue insertNewDefaultValues(int i)

Internal Use Only.

addNewDefaultValues

PromptValue addNewDefaultValues()

Internal Use Only.

removeDefaultValues

void removeDefaultValues(int i)

Internal Use Only.

getPreviousValuesArray

PromptValue[] getPreviousValuesArray()

Returns an array containing values selected on the last document refresh.

Returns:

An array of PromptValue.

getPreviousValuesArray

PromptValue getPreviousValuesArray(int i)

Returns one of value selected on the last document refresh.

Parameters:

i - The index of the PromptValue to be retrieved.

Returns:

A single PromptValue.

isNilPreviousValuesArray

boolean isNilPreviousValuesArray(int i)

Checks if the PreviousValues element is nil at the specified index position.

Parameters:

i - the index of the PreviousValues element

Returns:

true if the PreviousValues element is nil, otherwise false

sizeOfPreviousValuesArray

int sizeOfPreviousValuesArray()

Returns the size of the PreviousValues array.

Returns:

the size of the PreviousValues array.

setPreviousValuesArray

void setPreviousValuesArray(PromptValue[] previousValuesArray)

Internal Use Only.

setPreviousValuesArray

void setPreviousValuesArray(int i,
                            PromptValue previousValues)

Internal Use Only.

setNilPreviousValuesArray

void setNilPreviousValuesArray(int i)

Internal Use Only.

insertNewPreviousValues

PromptValue insertNewPreviousValues(int i)

Internal Use Only.

addNewPreviousValues

PromptValue addNewPreviousValues()

Internal Use Only.

removePreviousValues

void removePreviousValues(int i)

Internal Use Only.

getPromptValueFormatArray

java.lang.String[] getPromptValueFormatArray()

Returns an array of strings containing possible formats for the prompt value.

Returns:

An array of strings containing PromptValue formats.

getPromptValueFormatArray

java.lang.String getPromptValueFormatArray(int i)

Returns a possible format for the prompt value.

Parameters:

i - The index of the PromptValue format to be retrieved.

Returns:

A single PromptValue format.

xgetPromptValueFormatArray

org.apache.xmlbeans.XmlString[] xgetPromptValueFormatArray()

Internal Use Only.

xgetPromptValueFormatArray

org.apache.xmlbeans.XmlString xgetPromptValueFormatArray(int i)

Internal Use Only.

isNilPromptValueFormatArray

boolean isNilPromptValueFormatArray(int i)

Checks if the PromptValueFormat element is nil at the specified index position.

Parameters:

i - the index of the PromptValueFormat element

Returns:

true if the PromptvalueFormat element is nil, otherwise false

sizeOfPromptValueFormatArray

int sizeOfPromptValueFormatArray()

Returns the size of the PromptvalueFormat array.

Returns:

the size of the PromptvalueFormat array.

setPromptValueFormatArray

void setPromptValueFormatArray(java.lang.String[] promptValueFormatArray)

Internal Use Only.

setPromptValueFormatArray

void setPromptValueFormatArray(int i,
                               java.lang.String promptValueFormat)

Internal Use Only.

xsetPromptValueFormatArray

void xsetPromptValueFormatArray(org.apache.xmlbeans.XmlString[] promptValueFormatArray)

Internal Use Only.

xsetPromptValueFormatArray

void xsetPromptValueFormatArray(int i,
                                org.apache.xmlbeans.XmlString promptValueFormat)

Internal Use Only.

setNilPromptValueFormatArray

void setNilPromptValueFormatArray(int i)

Internal Use Only.

insertPromptValueFormat

void insertPromptValueFormat(int i,
                             java.lang.String promptValueFormat)

Internal Use Only.

addPromptValueFormat

void addPromptValueFormat(java.lang.String promptValueFormat)

Internal Use Only.

insertNewPromptValueFormat

org.apache.xmlbeans.XmlString insertNewPromptValueFormat(int i)

Internal Use Only.

addNewPromptValueFormat

org.apache.xmlbeans.XmlString addNewPromptValueFormat()

Internal Use Only.

removePromptValueFormat

void removePromptValueFormat(int i)

Internal Use Only.

getMinValue

PromptValue getMinValue()

Returns the minimum value possible for this prompt.

Returns:

A PromptValue holding the minimum value possible for this prompt.

isNilMinValue

boolean isNilMinValue()

Checks if the MinValue element is nil.

Returns:

true if the MinValue element is nil, otherwise false

isSetMinValue

boolean isSetMinValue()

Checks if the MinValue element is set.

Returns:

true if the MinValue element is set, otherwise false

setMinValue

void setMinValue(PromptValue minValue)

Internal Use Only.

addNewMinValue

PromptValue addNewMinValue()

Appends and returns a new empty MinValue element.

Returns:

a new empty MinValue element.

setNilMinValue

void setNilMinValue()

Internal Use Only.

unsetMinValue

void unsetMinValue()

Internal Use Only.

getMaxValue

PromptValue getMaxValue()

Returns the maximum value possible for this prompt.

Returns:

A PromptValue holding the maximum value possible for this prompt.

isNilMaxValue

boolean isNilMaxValue()

Checks if the MaxValue element is nil.

Returns:

true if the MaxValue element is nil, otherwise false

isSetMaxValue

boolean isSetMaxValue()

Checks if the MaxValue element is set.

Returns:

true if the MaxValue element is set, otherwise false

setMaxValue

void setMaxValue(PromptValue maxValue)

Internal Use Only.

addNewMaxValue

PromptValue addNewMaxValue()

Appends and returns a new empty MaxValue element

Returns:

a new empty MaxValue element

setNilMaxValue

void setNilMaxValue()

Internal Use Only.

unsetMaxValue

void unsetMaxValue()

Internal Use Only.

getLOV

LOV getLOV()

Returns the List Of Values associated with this prompt. The RetrievePromptsInfo object, which is passed to the ReportEngine.getDocumentInformation, defines the way to retrieve the LOVs.

Returns:

The LOV.

See Also:

LOV, RetrievePromptsInfo

isNilLOV

boolean isNilLOV()

Checks if the LOV element is nil.

Returns:

true if the LOV element is nil, otherwise false

isSetLOV

boolean isSetLOV()

Checks if the LOV element is set.

Returns:

true if the LOV element is set, otherwise false

setLOV

void setLOV(LOV lov)

Internal Use Only.

addNewLOV

LOV addNewLOV()

Internal Use Only.

setNilLOV

void setNilLOV()

Internal Use Only.

unsetLOV

void unsetLOV()

Internal Use Only.

getDataProviderIDsArray

java.lang.String[] getDataProviderIDsArray()

Returns an array of data provider IDs.

Returns:

An array of data provider IDs.

getDataProviderIDsArray

java.lang.String getDataProviderIDsArray(int i)

Returns the data provider ID at the specified index position.

Parameters:

i - The index position.

Returns:

The data provider ID.

xgetDataProviderIDsArray

org.apache.xmlbeans.XmlString[] xgetDataProviderIDsArray()

Internal Use Only.

xgetDataProviderIDsArray

org.apache.xmlbeans.XmlString xgetDataProviderIDsArray(int i)

Internal Use Only.

isNilDataProviderIDsArray

boolean isNilDataProviderIDsArray(int i)

Checks if the DataProviderIDs element is nil at the specified index position.

Parameters:

i - the index of the DataProviderIDs element

Returns:

true if the DataProviderIDs element is nil, otherwise false

sizeOfDataProviderIDsArray

int sizeOfDataProviderIDsArray()

Returns the size of the DataProviderIDs array

Returns:

the size of the DataProviderIDs array

setDataProviderIDsArray

void setDataProviderIDsArray(java.lang.String[] dataProviderIDsArray)

Internal Use Only.

setDataProviderIDsArray

void setDataProviderIDsArray(int i,
                             java.lang.String dataProviderIDs)

Internal Use Only.

xsetDataProviderIDsArray

void xsetDataProviderIDsArray(org.apache.xmlbeans.XmlString[] dataProviderIDsArray)

Internal Use Only.

xsetDataProviderIDsArray

void xsetDataProviderIDsArray(int i,
                              org.apache.xmlbeans.XmlString dataProviderIDs)

Internal Use Only.

setNilDataProviderIDsArray

void setNilDataProviderIDsArray(int i)

Internal Use Only.

insertDataProviderIDs

void insertDataProviderIDs(int i,
                           java.lang.String dataProviderIDs)

Internal Use Only.

addDataProviderIDs

void addDataProviderIDs(java.lang.String dataProviderIDs)

Internal Use Only.

insertNewDataProviderIDs

org.apache.xmlbeans.XmlString insertNewDataProviderIDs(int i)

Internal Use Only.

addNewDataProviderIDs

org.apache.xmlbeans.XmlString addNewDataProviderIDs()

Internal Use Only.

removeDataProviderIDs

void removeDataProviderIDs(int i)

Internal Use Only.

getPromptToBeFilledArray

PromptInfo[] getPromptToBeFilledArray()

Gets the array of PromptToBeFilled elements.

Returns:

the array of PromptInfo.

getPromptToBeFilledArray

PromptInfo getPromptToBeFilledArray(int i)

Gets the PromptToBeFilled element at the specified index position.

Parameters:

i - the index of the PromptToBeFilled element

Returns:

the PromptInfo object

isNilPromptToBeFilledArray

boolean isNilPromptToBeFilledArray(int i)

Checks if the PromptToBeFilled element is nil at the specified index position.

Parameters:

i - the index of the PromptToBeFilled element

Returns:

true if the PromptToBeFilled element is nil, otherwise false

sizeOfPromptToBeFilledArray

int sizeOfPromptToBeFilledArray()

Returns the size of the PromptToBeFilled array

Returns:

the size of the PromptToBeFilled array

setPromptToBeFilledArray

void setPromptToBeFilledArray(PromptInfo[] promptToBeFilledArray)

Internal Use Only.

setPromptToBeFilledArray

void setPromptToBeFilledArray(int i,
                              PromptInfo promptToBeFilled)

Internal Use Only.

setNilPromptToBeFilledArray

void setNilPromptToBeFilledArray(int i)

Internal Use Only.

insertNewPromptToBeFilled

PromptInfo insertNewPromptToBeFilled(int i)

Internal Use Only.

addNewPromptToBeFilled

PromptInfo addNewPromptToBeFilled()

Internal Use Only.

removePromptToBeFilled

void removePromptToBeFilled(int i)

Internal Use Only.

getLovDisplayType

LovDisplayType.Enum getLovDisplayType()

Returns the display type of the LOV.

Returns:

the LovDisplayType object

xgetLovDisplayType

LovDisplayType xgetLovDisplayType()

Internal Use Only.

isNilLovDisplayType

boolean isNilLovDisplayType()

Checks if the LovDisplayType element is nil.

Returns:

true if the LovDisplayType element is nil, otherwise false

setLovDisplayType

void setLovDisplayType(LovDisplayType.Enum lovDisplayType)

Internal Use Only.

xsetLovDisplayType

void xsetLovDisplayType(LovDisplayType lovDisplayType)

Internal Use Only.

setNilLovDisplayType

void setNilLovDisplayType()

Internal Use Only.

getLovDelegated

boolean getLovDelegated()

Returns true, if this LOV is delegated

Example: Check whether LOVs are delegated or not

 LOVSearch objLOVSearch = LOVSearch.Factory.newInstance();
 objLOVSearch.setPattern("*a");
 objLOVSearch.setCaseSensitive(true);

 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrievePromptsInfo promptInfo = RetrievePromptsInfo.Factory.newInstance();
 promptInfo.setPromptLOVRetrievalMode(PromptLOVRetrievalMode.ALL);
 promptInfo.setRefreshReturnedLOVs(true);
 promptInfo.setReturnLOVOnMustFillPrompts(false);
 promptInfo.setLOVSearch(objLOVSearch);
 fillInfo.setRetrievePromptsInfo(promptInfo);

 Action[] actions = new Action[1];
 // Add a Refresh action to the Action array.
 actions[0] = Refresh.Factory.newInstance();
 // Obtain a DocumentInformation object from the ReportEngine.
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(docid,fillInfo,actions,null,null);

 if (boDocInfo.getMustFillPrompts())
 {
   PromptInfo[] boPromptInfo = boDocInfo.getPromptInfoArray();
   out.print(boPromptInfo[0].getLovDelegated());
 }

Returns:

true, if this LOV is delegated, otherwise false

xgetLovDelegated

org.apache.xmlbeans.XmlBoolean xgetLovDelegated()

Internal Use Only.

setLovDelegated

void setLovDelegated(boolean lovDelegated)

Internal Use Only.

xsetLovDelegated

void xsetLovDelegated(org.apache.xmlbeans.XmlBoolean lovDelegated)

Internal Use Only.

getName

java.lang.String getName()

Returns the name of the prompt.

Returns:

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.

getLocalizedQuestion

java.lang.String getLocalizedQuestion()

Returns the translated question.

Returns:

the String value of the localized question.

xgetLocalizedQuestion

org.apache.xmlbeans.XmlString xgetLocalizedQuestion()

Internal use only

setLocalizedQuestion

void setLocalizedQuestion(java.lang.String localizedQuestion)

Internal use only

xsetLocalizedQuestion

void xsetLocalizedQuestion(org.apache.xmlbeans.XmlString localizedQuestion)

Internal use only

getID

java.lang.String getID()

Returns the prompt ID.
This value is used:

• to recuperate the LOV associated to this prompt.
• to fill prompt values.

Returns:

The prompt ID.

See Also:

FillPrompt, FillPrompts, RetrievePromptsInfo, LOV

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Internal Use Only.

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.

getConstrained

boolean getConstrained()

Returns true, if the user fills a prompt with a value from a List Of Values.
This property is set by the document author.

Returns:

true, if the user fills a prompt with a value from a List Of Values.

See Also:

LOV

xgetConstrained

org.apache.xmlbeans.XmlBoolean xgetConstrained()

Internal Use Only.

setConstrained

void setConstrained(boolean constrained)

Internal Use Only.

xsetConstrained

void xsetConstrained(org.apache.xmlbeans.XmlBoolean constrained)

Internal Use Only.

getRequireAnswers

boolean getRequireAnswers()

Returns true, if the prompt has to be filled.

Returns:

true, if a user answer is required.

xgetRequireAnswers

org.apache.xmlbeans.XmlBoolean xgetRequireAnswers()

Internal Use Only.

setRequireAnswers

void setRequireAnswers(boolean requireAnswers)

Internal Use Only.

xsetRequireAnswers

void xsetRequireAnswers(org.apache.xmlbeans.XmlBoolean requireAnswers)

Internal Use Only.

getHasLOV

boolean getHasLOV()

Returns true, if this prompt has an associated List Of Values.

Returns:

true, if the prompt has a List Of Value

See Also:

LOV

xgetHasLOV

org.apache.xmlbeans.XmlBoolean xgetHasLOV()

Internal Use Only.

setHasLOV

void setHasLOV(boolean hasLOV)

Internal Use Only.

xsetHasLOV

void xsetHasLOV(org.apache.xmlbeans.XmlBoolean hasLOV)

Internal Use Only.

getAllowMultiValues

boolean getAllowMultiValues()

Returns true, if this prompt is allowed multiple values.

Returns:

true, if this prompt is allowed multiple values.

xgetAllowMultiValues

org.apache.xmlbeans.XmlBoolean xgetAllowMultiValues()

Internal Use Only.

setAllowMultiValues

void setAllowMultiValues(boolean allowMultiValues)

Internal Use Only.

xsetAllowMultiValues

void xsetAllowMultiValues(org.apache.xmlbeans.XmlBoolean allowMultiValues)

Internal Use Only.

getAllowDiscreteValue

boolean getAllowDiscreteValue()

Returns true, if this prompt is allowed to take one or more DiscretePromptValue objects.

Returns:

true, if this prompt is allowed to take one or more DiscretePromptValue objects.

See Also:

DiscretePromptValue

xgetAllowDiscreteValue

org.apache.xmlbeans.XmlBoolean xgetAllowDiscreteValue()

Internal Use Only.

setAllowDiscreteValue

void setAllowDiscreteValue(boolean allowDiscreteValue)

Internal Use Only.

xsetAllowDiscreteValue

void xsetAllowDiscreteValue(org.apache.xmlbeans.XmlBoolean allowDiscreteValue)

Internal Use Only.

getAllowRangeValue

boolean getAllowRangeValue()

Returns true, if this prompt is allowed to take one or more RangePromptValue objects.

Returns:

true, if this prompt is allowed to take one or more RangePromptValue objects.

See Also:

RangePromptValue

xgetAllowRangeValue

org.apache.xmlbeans.XmlBoolean xgetAllowRangeValue()

Internal Use Only.

setAllowRangeValue

void setAllowRangeValue(boolean allowRangeValue)

Internal Use Only.

xsetAllowRangeValue

void xsetAllowRangeValue(org.apache.xmlbeans.XmlBoolean allowRangeValue)

Internal Use Only.

getPromptType

PromptType.Enum getPromptType()

Returns the type of values the prompt takes.
The value type can be:

• NUMERIC
• TEXT
• BOOLEAN
• CURRENCY
• DATETIME
• TIME
• DATE

Returns:

The type of values the prompt takes.

See Also:

PromptType

xgetPromptType

PromptType xgetPromptType()

Internal Use Only.

setPromptType

void setPromptType(PromptType.Enum promptType)

Internal Use Only.

xsetPromptType

void xsetPromptType(PromptType promptType)

Internal Use Only.

getAllowNonLeafValues

boolean getAllowNonLeafValues()

Returns true if the value is at root level, otherwise false.

Returns:

true if the value is at root level, otherwise false.

xgetAllowNonLeafValues

org.apache.xmlbeans.XmlBoolean xgetAllowNonLeafValues()

Internal Use Only.

setAllowNonLeafValues

void setAllowNonLeafValues(boolean allowNonLeafValues)

Internal Use Only.

xsetAllowNonLeafValues

void xsetAllowNonLeafValues(org.apache.xmlbeans.XmlBoolean allowNonLeafValues)

Internal Use Only.

getOptional

boolean getOptional()

Returns true, if this prompt is optional one.

Returns:

true, if this prompt is optional one, otherwise false.

xgetOptional

org.apache.xmlbeans.XmlBoolean xgetOptional()

Internal Use Only.

isSetOptional

boolean isSetOptional()

Checks if the Optional attribute is set.

Returns:

"true", if this prompt is optional one, otherwise false.

setOptional

void setOptional(boolean optional)

Internal Use Only.

xsetOptional

void xsetOptional(org.apache.xmlbeans.XmlBoolean optional)

Internal Use Only.

unsetOptional

void unsetOptional()

Internal Use Only.