public interface

WebDimtyPrompt

implements WebPrompt
com.microstrategy.web.objects.WebDimtyPrompt

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebDimty getAnswer()
Returns the current prompt answer
abstract WebDimty getDefaultAnswer()
Returns the default prompt answer
abstract WebDimty getPreviousAnswer()
Returns the previous prompt answer
abstract WebSearch getSearchRestriction()
Returns the search restriction for building available answers collection (see getAvailableDisplayUnits()).
abstract WebFolder getSuggestedAnswers(boolean createIfNull)
abstract WebFolder getSuggestedAnswers()
Returns a read-only folder containing suggested answer objects or null if no suggested answers are defined.
abstract WebDimty setAnswer(WebDimty answer)
Sets the current prompt answer.
abstract void setSearchRestriction(WebSearch search)
Sets the search restriction for building available answers collection (see getAvailableDisplayUnits()).
[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 WebDimty getAnswer ()

Returns the current prompt answer

Returns
  • the current prompt answer

public abstract WebDimty getDefaultAnswer ()

Returns the default prompt answer

Returns
  • the default prompt answer

public abstract WebDimty getPreviousAnswer ()

Returns the previous prompt answer

Returns
  • the previous prompt answer

public abstract WebSearch getSearchRestriction ()

Returns the search restriction for building available answers collection (see 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.

public abstract WebFolder getSuggestedAnswers (boolean createIfNull)

public abstract 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 getAvailableDisplayUnits()).

Returns
  • a read-only folder containing suggested answer objects or null

public abstract 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.

public abstract void setSearchRestriction (WebSearch search)

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

Parameters
search a search restriction.