public interface

DimtyPromptBean

implements PromptBean
com.microstrategy.web.beans.DimtyPromptBean

Class Overview

Interface of the Dimty Prompt Bean.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebDimtyUnit addDimtyUnit(WebObjectInfo objInfo)
Add a dimty unit to the answer based on WebObjectInfo.
abstract WebDimtyUnit addDimtyUnit(int dimtyType)
Add a dimty unit to the answer based on dimty type.
abstract void clearAnswer()
Clears the prompt answer.
abstract WebDimty getAnswer()
Returns the answer of the dimty prompt.
abstract FolderBean getAvailableItemsAsFolder()
Return the available list defined by search or predefined list.
abstract WebDimtyUnit getReportLevelDimtyUnit()
Return the dimty unit which represents the "Report Level" (DssXmlDimtyUnitTypeReportBaseLevel).
abstract WebSearch getSearchObject()
Returns the search object associated with the prompt.
abstract void removeDimtyUnit(int key)
Removes a dimty unit from the answer based on the key.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.PromptBean
From interface com.microstrategy.web.beans.PromptObject
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract WebDimtyUnit addDimtyUnit (WebObjectInfo objInfo)

Add a dimty unit to the answer based on WebObjectInfo.

Parameters
objInfo WebObjectInfo to add.
Returns

public abstract WebDimtyUnit addDimtyUnit (int dimtyType)

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

Parameters
dimtyType - type of dimty unit.
Returns

public abstract void clearAnswer ()

Clears the prompt answer.

public abstract WebDimty getAnswer ()

Returns the answer of the dimty prompt.

Returns

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

public abstract WebDimtyUnit getReportLevelDimtyUnit ()

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

Returns
  • A dimty unit represents the "Report Level".

public abstract WebSearch getSearchObject ()

Returns the search object associated with the prompt.

Returns

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