Package com.microstrategy.web.objects

Interface WebDimtyPrompt

All Superinterfaces:

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

public interface WebDimtyPrompt
extends WebPrompt

This interface represents Dimensionality prompt, whose answer is of type WebDimty. This object corresponds Level prompt in desktop.

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
WebDimty	getAnswer()	Returns the current prompt answer
WebDimty	getDefaultAnswer()	Returns the default prompt answer
WebDimty	getPreviousAnswer()	Returns the previous prompt answer
WebSearch	getSearchRestriction()	Returns the search restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()).
WebFolder	getSuggestedAnswers()	Returns a read-only folder containing suggested answer objects or null if no suggested answers are defined.
WebFolder	getSuggestedAnswers(boolean createIfNull)
WebDimty	setAnswer(WebDimty answer)	Sets the current prompt answer.
void	setSearchRestriction(WebSearch search)	Sets the search restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()).

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, validate

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

getPromptInstances

Method Detail

getAnswer

WebDimty getAnswer()

Returns the current prompt answer

Returns:

the current prompt answer

setAnswer

WebDimty setAnswer(WebDimty answer)

Sets the current prompt answer. Internally this method creates a new copy of the answer object and stores it as the current answer. (If the answer object is the same as the current answer no copy is created).

Parameters:

answer - a prompt answer

Returns:

a current answer that is a newly created copy of the answer object.

getDefaultAnswer

WebDimty getDefaultAnswer()

Returns the default prompt answer

Returns:

the default prompt answer

getPreviousAnswer

WebDimty getPreviousAnswer()

Returns the previous prompt answer

Returns:

the previous prompt answer

getSuggestedAnswers

WebFolder getSuggestedAnswers()

Returns a read-only folder containing suggested answer objects or null if no suggested answers are defined. This list will be used in building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()).

Returns:

a read-only folder containing suggested answer objects or null

getSuggestedAnswers

WebFolder getSuggestedAnswers(boolean createIfNull)

Since:

MicroStrategy Web 9.0.0

getSearchRestriction

WebSearch getSearchRestriction()

Returns the search restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()). If the predefined list of suggested answers is not empty (see getSuggestedAnswers) and no search restriction is defined, then this method will return null. If neither suggested answers list nor search restriction is defined this method will return a default search restriction that will search for all objects of type dimension and attribute in the project.

Returns:

the search restriction object or null.

setSearchRestriction

void setSearchRestriction(WebSearch search)

Sets the search restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()). The search restriction must return only objects of type dimension and attribute

Parameters:

search - a search restriction.