com.businessobjects.dsws.reportengine
Class PromptInfo

java.lang.Object
  com.businessobjects.dsws.reportengine.PromptInfo

All Implemented Interfaces:

java.io.Serializable

public class PromptInfo

extends java.lang.Object

implements java.io.Serializable

The PromptInfo class is used to resolve the prompting that may appear 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 boMustFill = new RetrieveMustFillInfo();
RetrievePromptsInfo promptInfo = new RetrievePromptsInfo();
boMustFill.setRetrievePromptsInfo(promptInfo);
DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strBODocuid, boMustFill, null, null, null);
if (docInfo.isMustFillPrompts()==true)
{
PromptInfo[] boPromptInfo = boDocInfo.getPromptInfo();
}


See Also:

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

Constructor Summary

PromptInfo()
Instantiate a new blank PromptInfo object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
org.apache.axis.message.MessageElement[]	get_any() Internal Use Only.
java.lang.String[]	getDataProviderIDs() Returns an array of data provider IDs.
java.lang.String	getDataProviderIDs(int i) Returns the data provider ID at the specified index position.
PromptValue[]	getDefaultValues() Returns an array containing the default values for this prompt.
PromptValue	getDefaultValues(int i) Returns one of the default values for this prompt.
java.lang.String	getDescription() Returns a description of the prompt.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
java.lang.String	getID() Returns the prompt ID.
LOV	getLOV() Returns the List Of Values associated with this prompt.
LovDisplayType	getLovDisplayType() Get the display type of the LOVs.
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.
PromptValue[]	getPreviousValues() Returns an array containing values selected on the last document refresh.
PromptValue	getPreviousValues(int i) Returns one of value selected on the last document refresh.
PromptInfo[]	getPromptToBeFilled() Get the prompt that is to be filled.
PromptInfo	getPromptToBeFilled(int i) Get the prompt of the specified index that is to be filled.
PromptType	getPromptType() Returns the type of values the prompt takes.
java.lang.String[]	getPromptValueFormat() Returns an array of strings containing possible formats for the prompt value.
java.lang.String	getPromptValueFormat(int i) Returns a possible format for the prompt value.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
int	hashCode() Internal Use Only.
boolean	isAllowDiscreteValue() Returns "true", if this prompt is allowed to take one or more DiscretePromptValue objects.
boolean	isAllowMultiValues() Returns "true", if this prompt is allowed multiple values.
boolean	isAllowNonLeafValues() Returns true if the value is at root level, otherwise false.
boolean	isAllowRangeValue() Returns "true", if this prompt is allowed to take one or more RangePromptValue objects.
boolean	isConstrained() Returns "true", if the user fills a prompt with a value from a List Of Values.
boolean	isHasLOV() Returns "true", if this prompt has an associated List Of Values.
boolean	isRequireAnswers() Returns "true", if the prompt has to be filled.
void	set_any(org.apache.axis.message.MessageElement[] _any) 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	setDataProviderIDs(int i, java.lang.String value) Sets the data provider ID at the specified index position.
void	setDataProviderIDs(java.lang.String[] dataProviderIDs) Sets an array of data provider IDs.
void	setDefaultValues(int i, PromptValue value) Internal Use Only.
void	setDefaultValues(PromptValue[] defaultValues) 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	setLOV(LOV LOV) Internal Use Only.
void	setLovDisplayType(LovDisplayType lovDisplayType) Set the display type (for example, hierarchical) for a LOV.
void	setMaxValue(PromptValue maxValue) Internal Use Only.
void	setMinValue(PromptValue minValue) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setPreviousValues(int i, PromptValue value) Internal Use Only.
void	setPreviousValues(PromptValue[] previousValues) Internal Use Only.
void	setPromptToBeFilled(int i, PromptInfo value) Set the prompt of the specified index that is to be filled.
void	setPromptToBeFilled(PromptInfo[] promptToBeFilled) Set the prompt that is to be filled.
void	setPromptType(PromptType promptType) Internal Use Only.
void	setPromptValueFormat(int i, java.lang.String value) Internal Use Only.
void	setPromptValueFormat(java.lang.String[] promptValueFormat) Internal Use Only.
void	setRequireAnswers(boolean requireAnswers) Internal Use Only.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PromptInfo

public PromptInfo()

Instantiate a new blank PromptInfo object.

Method Detail

getDescription

public java.lang.String getDescription()

Returns a description of the prompt.

Returns:

A description of the prompt.

setDescription

public void setDescription(java.lang.String description)

Internal Use Only.

getDefaultValues

public PromptValue[] getDefaultValues()

Returns an array containing the default values for this prompt.

Returns:

An array of PromptValue.

setDefaultValues

public void setDefaultValues(PromptValue[] defaultValues)

Internal Use Only.

getDefaultValues

public PromptValue getDefaultValues(int i)

Returns one of the default values for this prompt.

Parameters:

i - The index of the PromptValue to be retrieved.

Returns:

A single PromptValue.

setDefaultValues

public void setDefaultValues(int i,
                             PromptValue value)

Internal Use Only.

getPreviousValues

public PromptValue[] getPreviousValues()

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

Returns:

An array of PromptValue.

setPreviousValues

public void setPreviousValues(PromptValue[] previousValues)

Internal Use Only.

getPreviousValues

public PromptValue getPreviousValues(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.

setPreviousValues

public void setPreviousValues(int i,
                              PromptValue value)

Internal Use Only.

getPromptValueFormat

public java.lang.String[] getPromptValueFormat()

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

Returns:

An array of strings containing PromptValue formats.

setPromptValueFormat

public void setPromptValueFormat(java.lang.String[] promptValueFormat)

Internal Use Only.

getPromptValueFormat

public java.lang.String getPromptValueFormat(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.

setPromptValueFormat

public void setPromptValueFormat(int i,
                                 java.lang.String value)

Internal Use Only.

getMinValue

public PromptValue getMinValue()

Returns the minimum value possible for this prompt.

Returns:

A PromptValue holding the minimum value possible for this prompt.

setMinValue

public void setMinValue(PromptValue minValue)

Internal Use Only.

getMaxValue

public PromptValue getMaxValue()

Returns the maximum value possible for this prompt.

Returns:

A PromptValue holding the maximum value possible for this prompt.

setMaxValue

public void setMaxValue(PromptValue maxValue)

Internal Use Only.

getLOV

public 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

setLOV

public void setLOV(LOV LOV)

Internal Use Only.

getDataProviderIDs

public java.lang.String[] getDataProviderIDs()

Returns an array of data provider IDs.

Returns:

An array of data provider IDs.

setDataProviderIDs

public void setDataProviderIDs(java.lang.String[] dataProviderIDs)

Sets an array of data provider IDs.

Parameters:

dataProviderIDs - The array of data provider IDs.

getDataProviderIDs

public java.lang.String getDataProviderIDs(int i)

Returns the data provider ID at the specified index position.

Parameters:

i - The index position.

Returns:

The data provider ID.

setDataProviderIDs

public void setDataProviderIDs(int i,
                               java.lang.String value)

Sets the data provider ID at the specified index position.

Parameters:

i - The index position.

value - The data provider ID.

getPromptToBeFilled

public PromptInfo[] getPromptToBeFilled()

Get the prompt that is to be filled.

setPromptToBeFilled

public void setPromptToBeFilled(PromptInfo[] promptToBeFilled)

Set the prompt that is to be filled.

getPromptToBeFilled

public PromptInfo getPromptToBeFilled(int i)

Get the prompt of the specified index that is to be filled.

setPromptToBeFilled

public void setPromptToBeFilled(int i,
                                PromptInfo value)

Set the prompt of the specified index that is to be filled.

getLovDisplayType

public LovDisplayType getLovDisplayType()

Get the display type of the LOVs.

setLovDisplayType

public void setLovDisplayType(LovDisplayType lovDisplayType)

Set the display type (for example, hierarchical) for a LOV.

get_any

public org.apache.axis.message.MessageElement[] get_any()

Internal Use Only.

set_any

public void set_any(org.apache.axis.message.MessageElement[] _any)

Internal Use Only.

getName

public java.lang.String getName()

Returns the name of the prompt.

Returns:

The name of the prompt.

setName

public void setName(java.lang.String name)

Internal Use Only.

getID

public 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

setID

public void setID(java.lang.String ID)

Internal Use Only.

isConstrained

public boolean isConstrained()

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

setConstrained

public void setConstrained(boolean constrained)

Internal Use Only.

isRequireAnswers

public boolean isRequireAnswers()

Returns "true", if the prompt has to be filled.

Returns:

"true", if a user answer is required.

setRequireAnswers

public void setRequireAnswers(boolean requireAnswers)

Internal Use Only.

isHasLOV

public boolean isHasLOV()

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

Returns:

"true", if the prompt has a List Of Value

See Also:

LOV

setHasLOV

public void setHasLOV(boolean hasLOV)

Internal Use Only.

isAllowMultiValues

public boolean isAllowMultiValues()

Returns "true", if this prompt is allowed multiple values.

Returns:

"true", if this prompt is allowed multiple values.

setAllowMultiValues

public void setAllowMultiValues(boolean allowMultiValues)

Internal Use Only.

isAllowDiscreteValue

public boolean isAllowDiscreteValue()

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

setAllowDiscreteValue

public void setAllowDiscreteValue(boolean allowDiscreteValue)

Internal Use Only.

isAllowRangeValue

public boolean isAllowRangeValue()

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

setAllowRangeValue

public void setAllowRangeValue(boolean allowRangeValue)

Internal Use Only.

getPromptType

public PromptType 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

setPromptType

public void setPromptType(PromptType promptType)

Internal Use Only.

isAllowNonLeafValues

public boolean isAllowNonLeafValues()

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

setAllowNonLeafValues

public void setAllowNonLeafValues(boolean allowNonLeafValues)

Internal Use Only.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

hashCode

public int hashCode()

Internal Use Only.

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.