Package com.microstrategy.web.beans

Interface DimtyPromptBean

All Superinterfaces:

EnumWebPersistableState, Persistable, PromptBean, PromptObject, RequestPersistable, Transformable, WebBean, WebComponent

public interface DimtyPromptBean
extends PromptBean

Interface of the Dimty Prompt Bean.

Since:

MicroStrategy Web 9.0.0

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
WebDimtyUnit	addDimtyUnit(int dimtyType)	Add a dimty unit to the answer based on dimty type.
WebDimtyUnit	addDimtyUnit(WebObjectInfo objInfo)	Add a dimty unit to the answer based on WebObjectInfo.
void	clearAnswer()	Clears the prompt answer.
WebDimty	getAnswer()	Returns the answer of the dimty prompt.
FolderBean	getAvailableItemsAsFolder()	Return the available list defined by search or predefined list.
WebDimtyUnit	getReportLevelDimtyUnit()	Return the dimty unit which represents the "Report Level" (EnumDSSXMLDimtyUnitType.DssXmlDimtyUnitTypeReportBaseLevel).
WebSearch	getSearchObject()	Returns the search object associated with the prompt.
void	removeDimtyUnit(int key)	Removes a dimty unit from the answer based on the key.

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

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.PromptBean

getAvailableItems, getSelectedItems, isXDAMDXPrompt

Methods inherited from interface com.microstrategy.web.beans.PromptObject

getDisplayHelper, getHighlightedObjects, getOriginalSearchRoot, getPromptPosition, getPromptsBean, getPromptsSource, getUserSearchPattern, getValidationInfo, getWebPrompt, hasAnswerChanged, setAnswerChanged, setUserSearchPattern, setValidationInfo

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebBean

getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

getAnswer

WebDimty getAnswer()

Returns the answer of the dimty prompt.

Returns:

WebDimty collection.

clearAnswer

void clearAnswer()

Clears the prompt answer.

addDimtyUnit

WebDimtyUnit addDimtyUnit(int dimtyType)

Add a dimty unit to the answer based on dimty type.

Parameters:

dimtyType - - type of dimty unit.

Returns:

- added WebDimtyUnit.

addDimtyUnit

WebDimtyUnit addDimtyUnit(WebObjectInfo objInfo)

Add a dimty unit to the answer based on WebObjectInfo.

Parameters:

objInfo - WebObjectInfo to add.

Returns:

- added WebDimtyUnit

removeDimtyUnit

void removeDimtyUnit(int key)

Removes a dimty unit from the answer based on the key.

Parameters:

key - - key of the dimty unit to be removed.

getSearchObject

WebSearch getSearchObject()

Returns the search object associated with the prompt.

Returns:

WebSearch associated with the prompt.

getAvailableItemsAsFolder

FolderBean getAvailableItemsAsFolder()

Return the available list defined by search or predefined list. This list does not include the "Report Level" dimty unit, which should be also part of available for dimty prompt. You can get the "Report Level" dimty unit by calling getReportLevelDimtyUnit().

Returns:

A folder bean, which may include attribute and Hierarchy.

getReportLevelDimtyUnit

WebDimtyUnit getReportLevelDimtyUnit()

Return the dimty unit which represents the "Report Level" (EnumDSSXMLDimtyUnitType.DssXmlDimtyUnitTypeReportBaseLevel).

Returns:

A dimty unit represents the "Report Level".