public interface

WebConstantPrompt

implements WebPrompt
com.microstrategy.web.objects.WebConstantPrompt
Known Indirect Subclasses

Class Overview

This interface represents constant prompt.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract String getAnswer()
Returns the current prompt answer
abstract int getDataType()
Returns the prompts data type.
abstract String getDefaultAnswer()
Returns the default prompt answer
abstract String getPreviousAnswer()
Returns the previous prompt answer
abstract void setAnswer(String answer)
Sets the current prompt answer
abstract void setDataType(int dataType)
Sets the data type of the prompt.
abstract void setDefaultAnswer(String ans)
Sets the default prompt answer.
abstract void validate()
For specified data type getDataType(), validates whether prompt answer is in correct format and within minimun and maximum limits.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPrompt
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract String getAnswer ()

Returns the current prompt answer

Returns
  • the current prompt answer

public abstract int getDataType ()

Returns the prompts data type. The possible values are the following supbset from the EnumDSSXMLDataType: DssXmlDataTypeChar, DssXmlDataTypeBool, DssXmlDataTypeLong, DssXmlDataTypeDouble, DssXmlDataTypeDate.

public abstract String getDefaultAnswer ()

Returns the default prompt answer

Returns
  • the default prompt answer

public abstract String getPreviousAnswer ()

Returns the previous prompt answer

Returns
  • the previous prompt answer

public abstract void setAnswer (String answer)

Sets the current prompt answer

Parameters
answer a prompt answer

public abstract void setDataType (int dataType)

Sets the data type of the prompt. This will only work properly on a prompt definition, not a prompt question. The possible values are the following supbset from the EnumDSSXMLDataType: DssXmlDataTypeChar, DssXmlDataTypeBool, DssXmlDataTypeLong, DssXmlDataTypeDouble, DssXmlDataTypeDate.

public abstract void setDefaultAnswer (String ans)

Sets the default prompt answer. This only works on a prompt definition, not a prompt question.

public abstract void validate ()

For specified data type getDataType(), validates whether prompt answer is in correct format and within minimun and maximum limits. An exception is thrown if one of the conditions fails - check the error code to see which test failed.

Throws
Signals that the prompt answer failed validation requirements.
WebObjectsException