public interface

PromptDefinitionAppBean

implements EditableObjectAppBean
com.microstrategy.web.app.beans.PromptDefinitionAppBean

Class Overview

The PromptDefinitionAppBean is the application bean used for editing prompt definitions. This bean works in concert with the PromptDefinitionBean, and ties together a tab manager, the object selection bean, the prompts container bean, and the aforementioned PromptDefinitionBean. For proper operation, it is expected that this bean has a child TabManager, PromptDefinitionBean, and ObjectSelectionBean defined in the pageConfig.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract GUIOperator[] getAttributeQualificationInListOperators()
Returns the set of operators for this select expression type, when this is an expression prompt.
abstract GUIOperator[] getExpressionPromptOperators()
Returns the set of operators for this expression prompt, when this is an expression prompt.
abstract ObjectSelectionBean getObjectSelectionBean(int mode)
This method will return a child ObjectSelectionBean, if one exists.
abstract ObjectSelectionBean getObjectSelectionBean()
This method will return a child ObjectSelectionBean, if one exists.
abstract PromptDefinitionBean getPromptDefinitionBean()
This method will return a child PromptDefinitionBean.
abstract PromptsContainerBean getPromptsContainerBean()
Returns a child PromptsContainerBean, if one exists.
abstract TabManagerBean getTabManager()
This method will return a child TabManagerBean, if one exists.
abstract boolean isPromptSavedSuccessful()
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.EditableObjectAppBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract GUIOperator[] getAttributeQualificationInListOperators ()

Returns the set of operators for this select expression type, when this is an expression prompt.

public abstract GUIOperator[] getExpressionPromptOperators ()

Returns the set of operators for this expression prompt, when this is an expression prompt. The operators will be different for different expression type. The list is defined in PromptExpressionOperators.xml

public abstract ObjectSelectionBean getObjectSelectionBean (int mode)

This method will return a child ObjectSelectionBean, if one exists. In addition, if the bean is not already in the given editing mode, the given mode will be set. This is important because the act of setting the mode will effectively mark the "rollback" point that will be used by the bean if the user cancels the edit operation.

Returns

public abstract ObjectSelectionBean getObjectSelectionBean ()

This method will return a child ObjectSelectionBean, if one exists. The ObjectSelectionBean is a bean that can be used to select several different objects or lists of objects used in building prompts.

Returns

public abstract PromptDefinitionBean getPromptDefinitionBean ()

This method will return a child PromptDefinitionBean. It is required that the user create a child PromptDefinitionBean for this bean to be useful.

Returns
  • The child PromptDefinitionBean, or null if one does not exist.

public abstract PromptsContainerBean getPromptsContainerBean ()

Returns a child PromptsContainerBean, if one exists. The PromptsContainerBean is used for displaying default, and sometimes available, answers.

Returns

public abstract TabManagerBean getTabManager ()

This method will return a child TabManagerBean, if one exists.

Returns
  • The child TabManagerBean, or null if one does not exist.

public abstract boolean isPromptSavedSuccessful ()