Interface WebExpressionPrompt
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPrompt
,WebPromptSite
public interface WebExpressionPrompt extends WebPrompt
Represents an expression prompt, whose answer is of typeWebExpression
. This object corresponds to 3 types of prompt in desktop (Attribute Qualification, Hierarchical, Metric Qualification).- 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebExpression
getAnswer()
Returns the current prompt answer.WebFolder
getCustomDisplayedForms()
Returns a set of forms this prompt will qualify on, whengetDisplayedForms()
isEnumWebDisplayedForms.WebDisplayedFormsCustom
For setting up custom display forms, first need to callsetDisplayedForms(int)
to set it toEnumWebDisplayedForms.WebDisplayedFormsCustom
, then populate the folder returned from this method.WebExpression
getDefaultAnswer()
Returns the default prompt answerWebAttributeForm
getDefaultForm()
This optional property is used only with expression prompts of type attribute form qualification.WebFunction
getDefaultFunction()
This optional property is applicable only to the expression prompts supporting the SAP Variables.int
getDisplayedForms()
Returns which forms will be qualified upon, from the enumerationEnumWebDisplayedForms
.int
getExpressionType()
Returns expression type.WebMDXDisplayUnit
getMDXDisplayUnit(WebAttribute attribute)
This method returns the MDXDisplayUnit associated with the attribute.WebObjectInfo
getOrigin()
Returns a object that shall be used to obtained list of objects that can be used in the expression.WebObjectInfo
getOrigin(boolean createIfNull)
Returns a object that shall be used to obtained list of objects that can be used in the expression.WebExpression
getPreviousAnswer()
Returns the previous prompt answerWebFolder
getSuggestedAnswers()
WebFolder
getSuggestedAnswers(boolean createIfNull)
WebExpression
setAnswer(WebExpression answer)
Sets the current prompt answer.void
setDefaultForm(WebAttributeForm af)
void
setDisplayedForms(int forms)
void
setExpressionType(int type)
void
setOrigin(WebObjectInfo origin)
-
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, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, 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
-
getExpressionType
int getExpressionType()
Returns expression type. The possible expression types are the following subset from theEnumDSSXMLExpressionType
: DssXmlFilterSingleMetricQual, DssXmlFilterAttributeIDQual, DssXmlFilterAttributeDESCQual, DssXmlFilterAllAttributeQual.- Returns:
- expression type.
-
setExpressionType
void setExpressionType(int type)
- Since:
- MicroStrategy Web 9.0.0
-
getAnswer
WebExpression getAnswer()
Returns the current prompt answer. If there is no answer available, an emptyWebExpression
is returned, which can be used to build answer.- Returns:
- the current prompt answer
-
setAnswer
WebExpression setAnswer(WebExpression answer)
Sets the current prompt answer. Internally this method creates a new copy of theanswer
object and stores it as the current answer. (If theanswer
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
WebExpression getDefaultAnswer()
Returns the default prompt answer- Returns:
- the default prompt answer
-
getPreviousAnswer
WebExpression getPreviousAnswer()
Returns the previous prompt answer- Returns:
- the previous prompt answer
-
getOrigin
WebObjectInfo getOrigin() throws WebObjectsException
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
, orWebMetric
.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.
- Throws:
WebObjectsException
-
getOrigin
WebObjectInfo getOrigin(boolean createIfNull) throws WebObjectsException
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
, orWebMetric
.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.
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
setOrigin
void setOrigin(WebObjectInfo origin) throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getDefaultForm
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 typeWebAttribute
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
-
setDefaultForm
void setDefaultForm(WebAttributeForm af)
- Since:
- MicroStrategy Web 9.0.0
-
getDisplayedForms
int getDisplayedForms()
Returns which forms will be qualified upon, from the enumerationEnumWebDisplayedForms
.- Returns:
- A value from
EnumWebDisplayedForms
, corresponding to the forms that should be shown. WhenEnumWebDisplayedForms.WebDisplayedFormsCustom
returned from this method, that meansgetCustomDisplayedForms()
will return the list of form objects. - Since:
- MicroStrategy Web 8.0.0
-
setDisplayedForms
void setDisplayedForms(int forms)
- Since:
- MicroStrategy Web 9.0.0
-
getCustomDisplayedForms
WebFolder getCustomDisplayedForms()
Returns a set of forms this prompt will qualify on, whengetDisplayedForms()
isEnumWebDisplayedForms.WebDisplayedFormsCustom
For setting up custom display forms, first need to callsetDisplayedForms(int)
to set it toEnumWebDisplayedForms.WebDisplayedFormsCustom
, then populate the folder returned from this method. Any modification of the returnedWebFolder
object (adding, deleting, reordering) will affect the custom display forms for this prompt.- Returns:
- A
WebFolder
contains custom displayed form objects.null
will be returned if currentgetDisplayedForms()
is notEnumWebDisplayedForms.WebDisplayedFormsCustom
- Since:
- MicroStrategy Web 9.0.0
-
getDefaultFunction
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 isEnumDSSXMLFunction.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.
- Since:
- MicroStrategy Web 8.0.1
-
getMDXDisplayUnit
WebMDXDisplayUnit getMDXDisplayUnit(WebAttribute attribute)
This method returns the MDXDisplayUnit associated with the attribute. The method returns a nonnull
value only for attributes which are part of the answer expression in a MDX report. In all other cases, the return value would benull
.- Since:
- MicroStrategy Web 8.1.2
-
getSuggestedAnswers
WebFolder getSuggestedAnswers()
- Since:
- MicroStrategy Web 9.0.0
-
getSuggestedAnswers
WebFolder getSuggestedAnswers(boolean createIfNull)
- Since:
- MicroStrategy Web 9.0.0
-
-