public interface

PromptDefinitionBean

implements EditableObjectBean
com.microstrategy.web.beans.PromptDefinitionBean

Class Overview

The PromptDefinitionBean is a bean which represents a prompt definition object in metadata. This interface contains methods that will allow the user to load, manipulate, and save prompt objects in metadata, and eventually, as embedded objects.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract PromptBean getAvailableListPromptBean()
Returns a PromptBean that can be used to display and modify the available list of a prompt.
abstract int getConstantPromptDataType()
Returns the datatype for a constant prompt.
abstract PromptBean getDefaultAnswerPromptBean()
Returns a PromptBean that can be used to display and modify the default answer of prompt.
abstract int getExpressionPromptExpressionType()
Returns the expression type for the expression prompt.
abstract int getPromptType()
Returns the current prompt type, from EnumWebPromptType.
abstract WebPrompt getWebPrompt()
Returns the WebPrompt object that is associated with the PromptDefinitionBean.
abstract void setConstantPromptDataType(int dataType)
Sets the datatype for a constant prompt.
abstract void setExpressionPromptExpressionType(int dataType)
Sets the expression type for a expression prompt.
abstract void setPromptType(int promptType)
Sets the type of prompt that the bean refers to.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.EditableBean
From interface com.microstrategy.web.beans.EditableObjectBean
From interface com.microstrategy.web.beans.ObjectBean
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 PromptBean getAvailableListPromptBean ()

Returns a PromptBean that can be used to display and modify the available list of a prompt. Note that this will only work for certain types of prompts - in particular, elements prompt is currently the only type supported, since the other types are fairly different in their semantics from the standard answer case. This PromptBean will expose the available list as the "answer" of the bean, and will modify the available list exposed by the bean appropriately in order to ensure that code which renders the regular answer can also render the available list with minimal changes.

Returns

public abstract int getConstantPromptDataType ()

Returns the datatype for a constant prompt.

Returns

public abstract PromptBean getDefaultAnswerPromptBean ()

Returns a PromptBean that can be used to display and modify the default answer of prompt. This PromptBean will expose the default answer on its getAnswer method, so that the bean can be used by any code which normally deals with regular answers to provide default answers as well.

Returns

public abstract int getExpressionPromptExpressionType ()

Returns the expression type for the expression prompt.

Returns

public abstract int getPromptType ()

Returns the current prompt type, from EnumWebPromptType.

Returns

public abstract WebPrompt getWebPrompt ()

Returns the WebPrompt object that is associated with the PromptDefinitionBean.

Returns
  • a WebPrompt object corresponding to the definition of the prompt.

public abstract void setConstantPromptDataType (int dataType)

Sets the datatype for a constant prompt.

Parameters
dataType A value from EnumDSSXMLDataType, representing the datatype of the prompt.

public abstract void setExpressionPromptExpressionType (int dataType)

Sets the expression type for a expression prompt.

Parameters
dataType A value from EnumDSSXMLExpressionType, representing the expressiontype of the prompt. The currently supported values are DssXmlFilterAttributeIDQual - Attribute Qualification Prompt DssXmlFilterSingleMetricQual - Metric Qualification Prompt DssXmlFilterAllAttributeQual - Hierarchy Qualification Prompt

public abstract void setPromptType (int promptType)

Sets the type of prompt that the bean refers to. If the prompt type changes, generally whatever state has been built up so far will be discarded, similar to calling setObjectID. After calling this method, you should generally call collectData to update the bean.

Parameters
promptType The type of prompt that this bean will represent, from EnumWebPromptType.