public interface

WebExpressionPrompt

implements WebPrompt
com.microstrategy.web.objects.WebExpressionPrompt

Class Overview

Represents an expression prompt, whose answer is of type WebExpression. This object corresponds to 3 types of prompt in desktop (Attribute Qualification, Hierarchical, Metric Qualification).

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebExpression getAnswer()
Returns the current prompt answer.
abstract WebFolder getCustomDisplayedForms()
Returns a set of forms this prompt will qualify on, when getDisplayedForms() is WebDisplayedFormsCustom For setting up custom display forms, first need to call setDisplayedForms(int) to set it to WebDisplayedFormsCustom, then populate the folder returned from this method.
abstract WebExpression getDefaultAnswer()
Returns the default prompt answer
abstract WebAttributeForm getDefaultForm()
This optional property is used only with expression prompts of type attribute form qualification.
abstract WebFunction getDefaultFunction()
This optional property is applicable only to the expression prompts supporting the SAP Variables.
abstract int getDisplayedForms()
Returns which forms will be qualified upon, from the enumeration EnumWebDisplayedForms.
abstract int getExpressionType()
Returns expression type.
abstract WebMDXDisplayUnit getMDXDisplayUnit(WebAttribute attribute)
This method returns the MDXDisplayUnit associated with the attribute.
abstract WebObjectInfo getOrigin(boolean createIfNull)
Returns a object that shall be used to obtained list of objects that can be used in the expression.
abstract WebObjectInfo getOrigin()
Returns a object that shall be used to obtained list of objects that can be used in the expression.
abstract WebExpression getPreviousAnswer()
Returns the previous prompt answer
abstract WebFolder getSuggestedAnswers(boolean createIfNull)
abstract WebFolder getSuggestedAnswers()
abstract WebExpression setAnswer(WebExpression answer)
Sets the current prompt answer.
abstract void setDefaultForm(WebAttributeForm af)
abstract void setDisplayedForms(int forms)
abstract void setExpressionType(int type)
abstract void setOrigin(WebObjectInfo origin)
[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 WebExpression getAnswer ()

Returns the current prompt answer. If there is no answer available, an empty WebExpression is returned, which can be used to build answer.

Returns
  • the current prompt answer

public abstract WebFolder getCustomDisplayedForms ()

Returns a set of forms this prompt will qualify on, when getDisplayedForms() is WebDisplayedFormsCustom For setting up custom display forms, first need to call setDisplayedForms(int) to set it to WebDisplayedFormsCustom, then populate the folder returned from this method. Any modification of the returned WebFolder object (adding, deleting, reordering) will affect the custom display forms for this prompt.

Returns

public abstract WebExpression getDefaultAnswer ()

Returns the default prompt answer

Returns
  • the default prompt answer

public abstract WebAttributeForm getDefaultForm ()

This optional property is used only with expression prompts of type attribute form qualification. Foe such prompts the prompt designer may optionally indicate a default attribute form that the GUI should highlight when presenting available forms for an attribute. In this case the origin property is of type WebAttribute which indicates that there is only one attribute you can use to build the expression. The expectation is that the Web application shows this form as highlighted, in case the application user has not explicitly highlighted any other attribute form.

Returns
  • the default attribute form or null

public abstract WebFunction getDefaultFunction ()

This optional property is applicable only to the expression prompts supporting the SAP Variables. For such an expression prompt, the prompt answer consists a single subexpression under the root node whose function is DssXmlFunctionTuple. The single subexpression must in turn be rooted at this function.

Returns
  • an function object or null if there is no such an auxilliary object.

public abstract int getDisplayedForms ()

Returns which forms will be qualified upon, from the enumeration EnumWebDisplayedForms.

Returns

public abstract int getExpressionType ()

Returns expression type. The possible expression types are the following subset from the EnumDSSXMLExpressionType: DssXmlFilterSingleMetricQual, DssXmlFilterAttributeIDQual, DssXmlFilterAttributeDESCQual, DssXmlFilterAllAttributeQual.

Returns
  • expression type.

public abstract WebMDXDisplayUnit getMDXDisplayUnit (WebAttribute attribute)

This method returns the MDXDisplayUnit associated with the attribute. The method returns a non null value only for attributes which are part of the answer expression in a MDX report. In all other cases, the return value would be null.

public abstract WebObjectInfo getOrigin (boolean createIfNull)

Returns a object that shall be used to obtained list of objects that can be used in the expression. It can be any of the following types: WebSearch, WebFolder, WebAttribute, WebDimension, or WebMetric.

In case of search object, the user can modify the search criterion that is used in generating the available object list. The search object can also be used to incrementally fetch the available object list. In case the origin property is missing, based on the parameter createIfNull the WebExpressionPrompt object would set origin property to be a search object to show all objects of type dimension and folder under the system folder "Data Explorer". As stated, the users can then modify the search object as they wish. For example, they can search for all objects of type dimension in the project root.

Parameters
createIfNull if true returns the default search object (to show all objects of type dimension and folder under the system folder "Data Explorer".)
Returns
  • a object that shall be used to obtained list of objects that can be used in the expression.

public abstract WebObjectInfo getOrigin ()

Returns a object that shall be used to obtained list of objects that can be used in the expression. It can be any of the following types: WebSearch, WebFolder, WebAttribute, WebDimension, or WebMetric.

In case of search object, the user can modify the search criterion that is used in generating the available object list. The search object can also be used to incrementally fetch the available object list. In case the origin property is missing, the WebExpressionPrompt object would set origin property to be a search object to show all objects of type dimension and folder under the system folder "Data Explorer". As stated, the users can then modify the search object as they wish. For example, they can search for all objects of type dimension in the project root.

Returns
  • a object that shall be used to obtained list of objects that can be used in the expression.

public abstract WebExpression getPreviousAnswer ()

Returns the previous prompt answer

Returns
  • the previous prompt answer

public abstract WebFolder getSuggestedAnswers (boolean createIfNull)

public abstract WebFolder getSuggestedAnswers ()

public abstract WebExpression setAnswer (WebExpression 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 setDefaultForm (WebAttributeForm af)

public abstract void setDisplayedForms (int forms)

public abstract void setExpressionType (int type)

public abstract void setOrigin (WebObjectInfo origin)