public class

PromptsContainerTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.PromptsContainerTransform
Known Direct Subclasses

Class Overview

This transform renders the PromptsContainerBean.

Summary

Constants
String DEFAULT_STYLE Denotes constant for getting prompt's default style name.
int MODE_ALL Indicates that all prompts should be displayed in one page.
int MODE_ONE_BY_ONE Indicates that one prompt per page should be displayed.
String PROMPT_LOADED_ARG Constant denoting argument for prompt loaded first time.
String STYLE_NAME_PROPERTY Denotes constant for getting prompt's style name.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String _1ptransImage Constant indicating source path to a transparent image.
protected PromptObject _firstPrompt Reference to first prompt in collection.
protected String _folderContextCurrentPath
protected List _folderContextList
protected PromptObject _lastPrompt Reference to last prompt in collection.
protected PromptObject _nextBlockPrompt Reference to next prompt in block.
protected PromptObject _nextPrompt Reference to next prompt in collection of prompts.
protected PromptsBean _pb Current Prompt bean.
protected PromptObject _previousBlockPrompt Reference to previous prompt in block.
protected PromptObject _previousPrompt Reference to previous prompt in collection of prompts.
protected List _promptStyleBeans
protected PromptsContainerBean _promptsContainerBean
protected boolean _renderProcessEvent
protected int _totalPrompts Indicates total of prompts defined in give prompted report.
public FormalParameter blockCount Specifies the number of prompts are displayed per block in report page.
public FormalParameter canCancelPrompt Indicates whether the cancel prompt button is displayed
public FormalParameter displayMode Specifies how multiple prompts will be displayed in report layout.
public FormalParameter executeButtonLabel Specifies the ID of the descriptor to use on the button for continue with document processing.
public FormalParameter formID Specifies the name and Id of the HTML form tag in report page.
public FormalParameter incrementalAttrElemBlockCount Specifies the maximum number of attribute elements to be displayed in available list when incremental fetch is available.
public FormalParameter incrementalObjectsBlockCount Specifies the maximum number of objects (attributes, attribute forms and metrics) to be displayed in available list when incremental fetch is available.
protected boolean isDhtmlMode Returns true if using DHTML.
public FormalParameter levelFlag Specifies what prompt region is displayed in report layout.
public FormalParameter multiplePromptCssFile Specifies the css file to use if it's multiple prompt information that requires to be rendered.
public FormalParameter promptQuestionLevelFlag Specifies what sections are displayed in prompt question layout.
public FormalParameter renderForm Indicates wheteher the transform will render its own form
protected FormalParameter showExecuteAtBottom Specifies whether or not to show an 'Execute' button at the bottom of the list of Prompts.
protected FormalParameter showExecuteAtTop Specifies whether or not to show an 'Execute' button at the top of the list of Prompts.
public FormalParameter showRequired Specifies whether or not to show required message in prompt question title.
public FormalParameter showSaveReportButton Indicates whether or not to display 'Save' button.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PromptsContainerTransform()
Default no-args constructor.
Public Methods
boolean canCancelPrompt()
boolean canDisplayIncrementalFetchButtons()
boolean canSavePrompt()
Indicates whether or not end-user is enabled to save given Prompted Report.
boolean displayPromptOneByOne()
Indicates whether or not to display prompts one by one.
List getAttForms(WebAttribute att)
ResultSetBean getContainerBean()
int getContainerBeanType()
String getCssName(WebObjectInfo object)
int getCurrentPromptPosition()
0 based.
String getDescription()
Returns description for this Transform.
String getExecuteButtonLabel()
Specifies label to be displayed in 'Execute' button.
PromptExpressionAppBean getExpressionPromptGUIBean()
List getFlattenedContextFolderList(int contextId)
String getFlattenedContextFolderPath(int contextId)
Map getFormAttributes()
int getMaxUploadFileSize()
String getNamedFolderId(int id)
Returns MicroStrategy DSSID for the corresponding named folder.
String getPromptFormID()
Block getPromptPageWidget(PromptAppBean promptStyleBean, boolean forModel)
Entry point for widget transform
String getPromptsBeanPath()
String getRootFolderId()
Class getSupportedBeanType()
Returns bean type class.
boolean includeOwnerInfo()
boolean includeTimeInfo()
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void initializeTransformForPromptsBean(Transformable data)
boolean isForDefinition()
Returns whether current transform is for editing a prompt.
boolean isForSubscription()
Returns whether current transform is for answering prompt in an subscription editor.
boolean isItemKeptInCartAvailable()
Indicates property value for whether or not selected item in cart's 'From' list should be removed.
boolean isMatchCaseShown()
Indicates property value for whether or not match case should be shown.
boolean isMultiplePrompt()
Indicates whether or not given report is consisted of more than one prompt.
boolean isNull(Object obj)
Returns whether the input argument is null.
boolean isOneByOneDisplayMode()
Indicates whether or not prompts should be rendered on the same page.
boolean isPromptStyleBeanOpen(PromptAppBean promptAppBean)
boolean isPromptSummaryViewable()
Indicates whether or not the Prompt container is Summary mode.
boolean isReprompted()
Retrieves the value 'isReprompted' from the WebResultSetInstance This allows us to read the reprompt propery from an SDK object rather than passing a property in the request.
boolean isShowObjectTags()
boolean nextButtonVisible()
int numOfPromptsPerPage()
boolean previousButtonVisible()
void renderAQListOperators(MarkupOutput out)
void renderAutoExpandOnDrill(MarkupOutput out)
void renderDateFormatPattern(MarkupOutput out)
void renderDateInputFormats(MarkupOutput out)
void renderDateOutputFormat(MarkupOutput out)
void renderDecimalSep(MarkupOutput out)
void renderGUIOperators(MarkupOutput out, GUIOperator[] opts)
void renderIntegerInputFormats(MarkupOutput out)
void renderIntegerOutputFormat(MarkupOutput out)
void renderLocaleID(MarkupOutput out)
void renderMetricValidationLevel(MarkupOutput out)
void renderNumberAndDateFormatDescriptor(MarkupOutput out, int desc)
void renderNumberInputFormats(MarkupOutput out)
void renderNumberOutputFormat(MarkupOutput out)
void renderPreferenceValue(MarkupOutput out, String prefName)
void renderPrompt(MarkupOutput out, PromptAppBean promptStyleBean)
void renderPromptAnchor(MarkupOutput out, PromptAppBean promptStyleBean)
Renders an anchor for each prompt so it is easily accessible from the Summary Section.
void renderPromptNumber(MarkupOutput out, PromptAppBean promptStyleBean)
Renders the prompt number which is displayed along each prompt question.
void renderThousandSep(MarkupOutput out)
void renderTimeInputFormats(MarkupOutput out)
void renderTimeOutputFormat(MarkupOutput out)
boolean shouldDisplayRenameMessage()
boolean shouldRenderCalendar()
boolean shouldRenderDimtyPopUp()
void transformForRequestSuccessful(MarkupOutput out)
Executes transform on PromptsBean when the status is "Successful".
Protected Methods
boolean areRequiredPromptsShownFirst()
Initializes property indicating whether or not Required prompts are displayed first.
void buildFlattenedContextFolderList(int contextId)
String getAnchorPinFromRequest()
Indicates prompt position based on GUI action.
WebEvent getAnswerEvent()
Returns Prompt's answer event.
WebEvent getCancelEvent()
Returns Prompt's cancel event.
String getDecimalSeparator()
Indicates current decimal separator for active Locale.
String getIsDatasetAddedArgumentName()
Indicates Argument name for specifying whether or not 'Adding Dataset' functionality was executed.
AppContext getPromptsAppContext()
Returns instance of AppContext.
PromptsBean getPromptsBean()
Returns instance of PromptsBean to be transformed.
WebEvent getSaveEvent()
Returns an event for saving prompted report or RWD or HTML document.
int getTotalOpenPrompts()
boolean isAddDatasetInRequest()
Indicates if in the request is an 'Add dataset' request.
void processIframeRequest(MarkupOutput out)
Process action from Report where user added a prompted metric to Filter.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

protected static final String DEFAULT_STYLE

Denotes constant for getting prompt's default style name.

Constant Value: "DefaultPSXSL"

public static final int MODE_ALL

Indicates that all prompts should be displayed in one page.

Constant Value: 1 (0x00000001)

public static final int MODE_ONE_BY_ONE

Indicates that one prompt per page should be displayed.

Constant Value: 2 (0x00000002)

protected static final String PROMPT_LOADED_ARG

Constant denoting argument for prompt loaded first time.

Constant Value: "promptLoaded"

protected static final String STYLE_NAME_PROPERTY

Denotes constant for getting prompt's style name.

Constant Value: "PSXSL"

Fields

protected String _1ptransImage

Constant indicating source path to a transparent image.

protected PromptObject _firstPrompt

Reference to first prompt in collection.

protected String _folderContextCurrentPath

protected List _folderContextList

protected PromptObject _lastPrompt

Reference to last prompt in collection.

protected PromptObject _nextBlockPrompt

Reference to next prompt in block.
Instance used in Incremental fetch when prompts are displayed each one in different page.

protected PromptObject _nextPrompt

Reference to next prompt in collection of prompts.

protected PromptsBean _pb

Current Prompt bean.

protected PromptObject _previousBlockPrompt

Reference to previous prompt in block.
Instance used in Incremental fetch when prompts are displayed each one in different page.

protected PromptObject _previousPrompt

Reference to previous prompt in collection of prompts.

protected List _promptStyleBeans

protected PromptsContainerBean _promptsContainerBean

protected boolean _renderProcessEvent

protected int _totalPrompts

Indicates total of prompts defined in give prompted report.

public FormalParameter blockCount

Specifies the number of prompts are displayed per block in report page.
Only applies when there are multiple prompts defined in given report and when display mode is set to display all prompts in one page. It indicates the number of prompts per block being displayed in page.
This flag is used as int value.

public FormalParameter canCancelPrompt

Indicates whether the cancel prompt button is displayed

public FormalParameter displayMode

Specifies how multiple prompts will be displayed in report layout.
This only applies when there are multiple prompts defined in given report. Prompts can be shown all or, one by one.
This flag is used as int value.
Allowed Values:

    MODE_ALL = 1
  • MODE_ONE_BY_ONE = 2

public FormalParameter executeButtonLabel

Specifies the ID of the descriptor to use on the button for continue with document processing. The id should be a valid ID in the Resources Bundle.
The default value is empty, in which case the Transform will use a predetermined value (which might be different between reports and documents). The string value for the formal parameter takes the form mstrWeb.3649

public FormalParameter formID

Specifies the name and Id of the HTML form tag in report page.
All prompts are part of one HTML form, which is submitted as request in order to be processed. This form has a unique name and id for indentifying it when prompt answers are processed. This value is also referenced from the Javascript files
This flag is used as text value.

public FormalParameter incrementalAttrElemBlockCount

Specifies the maximum number of attribute elements to be displayed in available list when incremental fetch is available.
Only applies in Element prompts. Prompt styles, such as list and radio button, are governed by this flag, even though they don't provide any incremental fetch functionality. This value is ignored by other prompt types and it gets by a Web preference end-user can edit. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report.
This flag is used as int value.
For more detailed information, please refer to Web preferences documentation. See Project defaults/General section, at Incremental fetch preference: "Maximum number of report objects per block".

public FormalParameter incrementalObjectsBlockCount

Specifies the maximum number of objects (attributes, attribute forms and metrics) to be displayed in available list when incremental fetch is available.
Only applies in Object and Expression prompts. Prompt styles, such as list and radio button, are governed by this flag, even though they don't provide any incremental fetch functionality. This value is ignored by other prompt types and it gets set by a Web preference end-user can edit. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report.
This flag is used as int value.
For more detailed information, please refer to Web preferences documentation. See Project defaults/General section, at Incremental fetch preference: "Maximum number of attributes per block".

protected boolean isDhtmlMode

Returns true if using DHTML. This values is initialized based on the getPromptsBean().getOutputFormat() method.

public FormalParameter levelFlag

Specifies what prompt region is displayed in report layout.
In order to allow prompt customization, report layout is broken into 6 displayable prompt regions: Execute buttons, prompt index, prompt summary, prompt question, prompt position and generic error.
This flag is used as bit-wise value.
Allowed Values:

    LEVEL_SHOW_EXECUTE_BUTTONS = 0x001
  • LEVEL_SHOW_PROMPT_INDEX = 0x002
  • LEVEL_SHOW_PROMPT_SUMMARY = 0x004
  • LEVEL_SHOW_PROMPT_QUESTIONS = 0x008
  • LEVEL_SHOW_PROMPT_POSITION = 0x010
  • LEVEL_SHOW_GENERIC_ERROR = 0x020
  • LEVEL_SHOW_EXECUTE_BUTTONS_TOP = 0x040
  • LEVEL_SHOW_EXECUTE_BUTTONS_BOTTOM = 0x080
  • LEVEL_SHOW_SAVE_BUTTON = 0x100
  • LEVEL_SHOW_WARNING_HEADER_MSSG = 0x200
  • LEVEL_SHOW_ALL = 0xfff

Default value is denoted by: EnumPromptLevelFlags.LEVEL_SHOW_ALL & ~ EnumPromptLevelFlags.LEVEL_SHOW_SAVE_BUTTON & ~ EnumPromptLevelFlags.LEVEL_SHOW_WARNING_HEADER_MSSG which indicates to display everything but 'Save' button and 'Warning Header Message' area.
For complete list, refer to EnumPromptLevelFlags

public FormalParameter multiplePromptCssFile

Specifies the css file to use if it's multiple prompt information that requires to be rendered.
This css file will be used together with the one indicated on the cssFile formal parameter.

public FormalParameter promptQuestionLevelFlag

Specifies what sections are displayed in prompt question layout.
In order to allow prompt customization, prompt question layout is broken into 4 displayable sections: Prompt title, prompt meaning, restriction, prompt content, prompt error and default answer. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report.
This flag is used as bit-wise value.
Allowed Values:

    LEVEL_SHOW_TITLE = 0x001
  • LEVEL_SHOW_MEANING = 0x002
  • LEVEL_SHOW_RESTRICTION = 0x004
  • LEVEL_SHOW_CONTENT = 0x008
  • LEVEL_SHOW_ERROR = 0x010
  • LEVEL_SHOW_DEFAULT_ANSWER = 0x020
  • LEVEL_SHOW_TITLE_BACKTOTOP = 0x040

For complete list, refer to EnumPromptLevelFlags

public FormalParameter renderForm

Indicates wheteher the transform will render its own form

protected FormalParameter showExecuteAtBottom

Specifies whether or not to show an 'Execute' button at the bottom of the list of Prompts.
This flag is used as int value. Possible values are defined in EnumPromptLevelFlags enumeration.
Allowed Values:

    LEVEL_DISPLAY_ELEMENT_YES = 1
  • LEVEL_DISPLAY_ELEMENT_NO = 2
  • LEVEL_DISPLAY_ELEMENT_USE_DEFAULT = 3

protected FormalParameter showExecuteAtTop

Specifies whether or not to show an 'Execute' button at the top of the list of Prompts.
This flag is used as int value. Possible values are defined in EnumPromptLevelFlags enumeration.
Allowed Values:

    LEVEL_DISPLAY_ELEMENT_YES = 1
  • LEVEL_DISPLAY_ELEMENT_NO = 2
  • LEVEL_DISPLAY_ELEMENT_USE_DEFAULT = 3

public FormalParameter showRequired

Specifies whether or not to show required message in prompt question title.
Per default, all prompts defined as required, display a "Required" message at the end of the prompt title. This flag will overrule this layout requirement by not displaying this message even though prompt is required. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report.
This flag is used as boolean value.

public FormalParameter showSaveReportButton

Indicates whether or not to display 'Save' button.

Public Constructors

public PromptsContainerTransform ()

Default no-args constructor.
Initialize all Formal Parameters.

Public Methods

public boolean canCancelPrompt ()

public boolean canDisplayIncrementalFetchButtons ()

public boolean canSavePrompt ()

Indicates whether or not end-user is enabled to save given Prompted Report.
Useful to determine whether or not to displaye 'Save' button in Prompt page.

Returns
  • true if user has proper permissions.

public boolean displayPromptOneByOne ()

Indicates whether or not to display prompts one by one.

Returns
  • true when only one prompt is to be displayed in a page.

public List getAttForms (WebAttribute att)

public ResultSetBean getContainerBean ()

public int getContainerBeanType ()

public String getCssName (WebObjectInfo object)

public int getCurrentPromptPosition ()

0 based. If no error, the return value should be 0. If there is an error for a prompt, the return the first error prompt position.

public String getDescription ()

Returns description for this Transform.

Returns
  • "This is the Transform that renders Prompts in the Application."

public String getExecuteButtonLabel ()

Specifies label to be displayed in 'Execute' button.
By default there are two possible labels: 'Run Report' or 'Run Document', based on the PromptsBean parent bean type.
However, the label to use can be controlled through the executeButtonLabel formal parameter. If a value has been specified, this method will return the corresponding string from the Resources-Bundle.

Returns
  • String localized message.

public PromptExpressionAppBean getExpressionPromptGUIBean ()

public List getFlattenedContextFolderList (int contextId)

public String getFlattenedContextFolderPath (int contextId)

public Map getFormAttributes ()

public int getMaxUploadFileSize ()

public String getNamedFolderId (int id)

Returns MicroStrategy DSSID for the corresponding named folder.

Parameters
id An value from EnumDSSXMLFolderNames
Returns
  • A string represents the DSSID of the named folder. If for any reason, the DSSID can not be figured out, an empty string will be returned.

public String getPromptFormID ()

public Block getPromptPageWidget (PromptAppBean promptStyleBean, boolean forModel)

Entry point for widget transform

public String getPromptsBeanPath ()

public String getRootFolderId ()

public Class getSupportedBeanType ()

Returns bean type class.
This transform returns the PromptsContainerBean.class

Returns
  • Class - the PromptsContainerBean

public boolean includeOwnerInfo ()

public boolean includeTimeInfo ()

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void initializeTransformForPromptsBean (Transformable data)

public boolean isForDefinition ()

Returns whether current transform is for editing a prompt.

Returns
  • true returned in prompt editing case. false returned in prompt runtime.

public boolean isForSubscription ()

Returns whether current transform is for answering prompt in an subscription editor.

Returns
  • true returned if prompt being answered in subscription page; false returned otherwise.

public boolean isItemKeptInCartAvailable ()

Indicates property value for whether or not selected item in cart's 'From' list should be removed.
Value is read from Preference object.

Returns
  • boolean, true if item is to be removed.

public boolean isMatchCaseShown ()

Indicates property value for whether or not match case should be shown.
Value is read from Preference object.

Returns
  • boolean, true if match case is to be shown.

public boolean isMultiplePrompt ()

Indicates whether or not given report is consisted of more than one prompt.

Returns
  • true when collection of prompts exceeds more than one.

public boolean isNull (Object obj)

Returns whether the input argument is null.

Parameters
obj The object to check again null
Returns
  • true if the input is null, otherwise false is returned.

public boolean isOneByOneDisplayMode ()

Indicates whether or not prompts should be rendered on the same page.

Returns
  • boolean true indicating all prompts are to be rendered in same page.

public boolean isPromptStyleBeanOpen (PromptAppBean promptAppBean)

public boolean isPromptSummaryViewable ()

Indicates whether or not the Prompt container is Summary mode.
Prompt summary page is rendered if user has requested it. This transform has a request property which indicates what mode Prompt container should be rendered like, either 'Summary' or 'Questions'.

Returns
  • true if current prompt page is 'Summary' mode.

public boolean isReprompted ()

Retrieves the value 'isReprompted' from the WebResultSetInstance This allows us to read the reprompt propery from an SDK object rather than passing a property in the request.

Returns
  • boolean

public boolean isShowObjectTags ()

public boolean nextButtonVisible ()

public int numOfPromptsPerPage ()

public boolean previousButtonVisible ()

public void renderAQListOperators (MarkupOutput out)

public void renderAutoExpandOnDrill (MarkupOutput out)

public void renderDateFormatPattern (MarkupOutput out)

public void renderDateInputFormats (MarkupOutput out)

public void renderDateOutputFormat (MarkupOutput out)

public void renderDecimalSep (MarkupOutput out)

public void renderGUIOperators (MarkupOutput out, GUIOperator[] opts)

public void renderIntegerInputFormats (MarkupOutput out)

public void renderIntegerOutputFormat (MarkupOutput out)

public void renderLocaleID (MarkupOutput out)

public void renderMetricValidationLevel (MarkupOutput out)

public void renderNumberAndDateFormatDescriptor (MarkupOutput out, int desc)

public void renderNumberInputFormats (MarkupOutput out)

public void renderNumberOutputFormat (MarkupOutput out)

public void renderPreferenceValue (MarkupOutput out, String prefName)

public void renderPrompt (MarkupOutput out, PromptAppBean promptStyleBean)

public void renderPromptAnchor (MarkupOutput out, PromptAppBean promptStyleBean)

Renders an anchor for each prompt so it is easily accessible from the Summary Section.

Parameters
out MarkupOutput where the contents to be rendered.
promptStyleBean PromptObject current prompt being rendered.

public void renderPromptNumber (MarkupOutput out, PromptAppBean promptStyleBean)

Renders the prompt number which is displayed along each prompt question.

Parameters
out MarkupOutput where the contents to render will be rendered.
promptStyleBean PromptObject current prompt being rendered.

public void renderThousandSep (MarkupOutput out)

public void renderTimeInputFormats (MarkupOutput out)

public void renderTimeOutputFormat (MarkupOutput out)

public boolean shouldDisplayRenameMessage ()

public boolean shouldRenderCalendar ()

public boolean shouldRenderDimtyPopUp ()

public void transformForRequestSuccessful (MarkupOutput out)

Executes transform on PromptsBean when the status is "Successful".

Parameters
out MarkupOutput instance where to write the output of the method.

Protected Methods

protected boolean areRequiredPromptsShownFirst ()

Initializes property indicating whether or not Required prompts are displayed first.
Value is read from Preference object.

protected void buildFlattenedContextFolderList (int contextId)

protected String getAnchorPinFromRequest ()

Indicates prompt position based on GUI action.
There are actions specific to GUI and not to Prompt's events such as switching from 'Qualify' to 'Select' in Hierarchical prompts. For such cases, prompt position remains the last one which couldn't be the prompt being edited.
This function will get prompt position being edited from request by looking up any of the GUI specific actions.

Returns
  • String prompt position.

protected WebEvent getAnswerEvent ()

Returns Prompt's answer event.

Returns
  • WebEvent instance for Answer

protected WebEvent getCancelEvent ()

Returns Prompt's cancel event.
This event will be determined based on parent Bean type. Cancel event will be obtained from either a DocumentBean or RWBean or ReportBean instance.
Cancel event will be either one for canceling Re-prompting or regular Prompted execution.

Returns
  • WebEvent for cancel event.

protected String getDecimalSeparator ()

Indicates current decimal separator for active Locale.

Returns
  • String decimal separator.

protected String getIsDatasetAddedArgumentName ()

Indicates Argument name for specifying whether or not 'Adding Dataset' functionality was executed.

Returns
  • String argument found in request.

protected AppContext getPromptsAppContext ()

Returns instance of AppContext.
AppContext instance is derived from existing Prompt's bean context.

Returns
  • instance of AppContext

protected PromptsBean getPromptsBean ()

Returns instance of PromptsBean to be transformed.

Returns

protected WebEvent getSaveEvent ()

Returns an event for saving prompted report or RWD or HTML document.

Returns
  • WebEvent where to write the output of the method.

protected int getTotalOpenPrompts ()

protected boolean isAddDatasetInRequest ()

Indicates if in the request is an 'Add dataset' request.
Likely, this prompt was induced by adding a prompted dataset in a running RW document.

Returns
  • true if request is an action performed in the hierarchical tree prompt.

protected void processIframeRequest (MarkupOutput out)

Process action from Report where user added a prompted metric to Filter.
Event is generated within Executed report. Most likely, end-user added a metric associated with a prompt. This required to execute given prompt.

Parameters
out MarkupOutput where to write output
Throws
IllegalStateException if any
IllegalArgumentException if any.