Package com.microstrategy.web.objects

Interface WebConstantPrompt

All Superinterfaces:

EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPrompt, WebPromptSite

All Known Subinterfaces:

WebTimePrompt

public interface WebConstantPrompt
extends WebPrompt

This interface represents constant prompt.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAnswer()	Returns the current prompt answer
int	getDataType()	Returns the prompts data type.
java.lang.String	getDefaultAnswer()	Returns the default prompt answer
java.lang.String	getPreviousAnswer()	Returns the previous prompt answer
void	setAnswer(java.lang.String answer)	Sets the current prompt answer
void	setDataType(int dataType)	Sets the data type of the prompt.
void	setDefaultAnswer(java.lang.String ans)	Sets the default prompt answer.
void	validate()	For specified data type getDataType(), validates whether prompt answer is in correct format and within minimun and maximum limits.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPrompt

answerPrompt, buildShortAnswerXML, getAnswerXML, getAnswerXML, getAnswerXML, getBrowsableDataSourceFlags, getDisplayHelper, getDisplayHelper, getDisplayProperties, getDSSPromptType, getKey, getMax, getMeaning, getMerge, getMessageId, getMin, getPIN, getPrimaryLocation, getPromptType, getReuse, getShortAnswerXML, getShortAnswerXML, getShortPa, getShortPa, getTitle, getUserAnswers, getXDATypes, hasAnswer, hasDefaultAnswer, hasOriginalAnswer, hasPreviousAnswer, isAnswerEmpty, isCanceled, isClosed, isRequired, isUsed, populateAnswer, resetAnswer, resetToDefault, setCanceled, setClosed, setMax, setMeaning, setMin, setRequired, setReuse, setTitle

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getDataType

int getDataType()

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

setDataType

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.

Since:

MicroStrategy Web 9.0.0

getAnswer

java.lang.String getAnswer()

Returns the current prompt answer

Returns:

the current prompt answer

setAnswer

void setAnswer(java.lang.String answer)

Sets the current prompt answer

Parameters:

answer - a prompt answer

getDefaultAnswer

java.lang.String getDefaultAnswer()

Returns the default prompt answer

Returns:

the default prompt answer

setDefaultAnswer

void setDefaultAnswer(java.lang.String ans)

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

Since:

MicroStrategy Web 9.0.0

getPreviousAnswer

java.lang.String getPreviousAnswer()

Returns the previous prompt answer

Returns:

the previous prompt answer

validate

void validate()
       throws WebObjectsException

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.

Specified by:

validate in interface WebPrompt

Throws:

WebAPIHelperException - Signals that the prompt answer failed validation requirements.

WebObjectsException

Since:

MicroStrategy Web 7.5.0