PromptsClassicTransform

Denotes constant for getting prompt's default style name.

Indicates that all prompts should be displayed in one page.

Indicates that one prompt per page should be displayed.

Constant denoting argument for prompt loaded first time.

Denotes constant for getting prompt's style name.

Constant indicating source path to a transparent image.

Reference to first prompt in collection.

Constant indicating source path to a Folder image.

Reference to last prompt in collection.

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

Reference to next prompt in collection of prompts.

Current Prompt bean.

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

Reference to previous prompt in collection of prompts.

Indicates total of prompts defined in give prompted report.

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.

Indicates whether the cancel prompt button is displayed

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

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

Specifies the ID of the descriptor to use on the button for continue with document processing.
Default value is for displaying 'Execute Document'.
This flag is used as string value.

Specifies the ID of the descriptor to use on the button for continue with report processing.
Default value is for displaying 'Execute Report'.
This flag is used as string value.

The name of the image for the first block in incremental fetching.

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.

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".

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".

The name of each image on the Prompt's content must be its position and this postfix, i.e. 1 + "_white.gif".

The name of each image on the Prompt's index must be its position and this postfix, i.e. 1 + "_white.gif".

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

The name of the image for the last block in incremental fetching.

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

The image for the lower corner of the frame for multi-prompted reports.
As of version 8.0, these formal parameters are not directly used by the application. They are still referenced by the renderPromptsContainer(MarkupOutput) method

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.

The name of the image for the next block in incremental fetching.

The name of the image for the previous block in incremental fetching.

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

Indicates wheteher the transform will render its own form

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

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

Specifies whether a match case checkbox is displayed at the end of a given search form within prompt question.
Not all prompt types support searching for elements or objects, so it could be ignored. A match case checkbox is normally displayed next to this search section. 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.

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.

Specifies whether prompts defined as required will be rendered first or not.
Applies only when prompts are displayed in one page. Prompts can be sorted by priority. Important: This FP is directly associated to a Project preference; this means that it can't be modified in StyleCatalog because it's a Transform property.
This flag is used as boolean value.

The name of the image for displaying the summary item.

The Image for the upper corner of the frame for multi-prompted reports.
As of version 8.0, these formal parameters are not directly used by the application. They are still referenced by the renderPromptsContainer(MarkupOutput) method

Default no-args constructor.
Initialize all Formal Parameters.

Indicates whether or not 'Save' button can be displayed.
Level flag is checked in order to determine this condition.

Indicates whether or not to display prompts one by one.

Creates a AnchorTag object (URL link) for invoking JS 'BuildUserSelections' method.

Returns description for this Transform.

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 current list of prompts.

Returns list of prompts determined by block count settings.

Returns list of prompts to be displayed in Summary mode.

Returns list of prompts sorted by 'one by one' mode.

Returns bean type class.

Initializes images to be used by this transform.
Parent method gets invoked so all shared images get initialized as well.

Initializes transform formal parameters.

Determines whether or not, top bottom buttons bar is viewable or not.
Reads formal parameter "showExecuteAtBottom' that indicates to display this bar which has higher precedence over Level flag.
This formal parameter might take following values:
Allowed Values:

LEVEL_DISPLAY_ELEMENT_YES = Indicates that manually display this bar.
• LEVEL_DISPLAY_ELEMENT_NO = Indicates not to display the bar.
• LEVEL_DISPLAY_ELEMENT_USE_DEFAULT = Indicates to determine whether or not to display bar based on default value.

Determines whether or not DHTML mode is on.

Indicates whether or not 'Execute' section is viewable.
Checks the level flags to find out whether or not the execute buttons should be displayed.

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

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

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

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

Indicates whether or not 'Prompt index' section can be rendered.
Uses Level flag to determine if this section is to be rendered.

Indicates whether or not prompt Index is viewable.
Only condition to enble prompt Index is to have multiple prompts in current page.

Indicates whether or not prompt questions are enabled.
It checkes level flag to see if LEVEL_SHOW_PROMPT_QUESTIONS is enabled.

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'.

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.

Determines whether or not, top execution buttons bar is viewable or not.
Reads formal parameter "showExecuteAtTop' that indicates to display this bar which will be displayed only if there are more than 1 prompt displayed in page and Prompt summary isn't displayed either. This FP has higher precedence over Level flag.
This formal parameter might take following values:
Allowed Values:

LEVEL_DISPLAY_ELEMENT_YES = Indicates that manually display this bar.
• LEVEL_DISPLAY_ELEMENT_NO = Indicates not to display the bar.
• LEVEL_DISPLAY_ELEMENT_USE_DEFAULT = Indicates to determine whether or not to display bar based on default value.

Renders Calendar component.
It only generates minimal HTML and JS code necessary for toggling Calendar component in current Prompt's page.

Renders the 'cancel' button on the prompt page.

Renders Prompt's execution bar.
This function will be responsible of rendering if neccessary, those prompt navigation buttons.
These navigations buttons are consisted of the following:

• 'Back to Prompt' - displayed only when summary mode is displayed.
• 'Previous' - Displayed only when prompts are displayed in separate pages and there are more than 1 prompt defined.
• 'Next' - Displayed only when prompts are displayed in separate pages and there are more than 1 prompt defined.

Renders the 'Execute' button on the prompt page.

Renders execution buttons for processing Prompts.
This buttons are different to those for navigation in terms of functionality. Pretty much, these buttons are used for executing and canceling prompts. Buttons displayed are for 'Execute Report' or 'Execute Document', 'Save' and 'Cancel'.

Renders the first/previous incremental fetch buttons.
It determines values for blockEnd and blockInit which are passed as parameters when invoking method renderFirstPreviousIncrementalFetch(MarkupOutput, int, int). These values are calculated by this transform.

Renders the first/previous incremental fetch buttons.

Renders any mesage before rendering prompts forms and prompt index.

Renders closing HTML tag.
This function is overwritten and adds an extra event for Saving Answer.

Renders opening HTML tag for Prompt's form.
In DHTML mode it adds an onSubmit event to the FORM tag, to call BuildUserSelections(n), where n is the number of prompts.
This method also renders the hidden inputs associated with the event.

Renders generic error message.
It'll display localized message 'Error in prompts'.

Renders an HTML image tag.

Renders an HTML image tag.

Renders incremental fetch section.
Incremental section where First, Previous, Next and Last incremental fetch buttons are organized. It invokes corresponding render methods.

Renders image for incremental fetch feature.
It is specified CSS, argument name and title.

Renders an HTML image TAG for the Prompts Index.

Renders a closing HTML tag for an anchor pointing to given Prompt.
Render the start of the A tag (Link) for the Prompts Index.

Renders an opening HTML tag for an anchor pointing to given Prompt.

Renders javascript variables at the bottom of the page to be used in DHTML mode.

Renders javascript variables on top of the page to be used in DHTML mode.

Renders HTML label around localized message denoted by given descriptor ID.

Renders HTML label around given text.

Renders a css file link corresponding to the file specified on the multiplePromptCssFile formal parameter.
If applicable (multiple prompt being rendered), these CSS links will be generated.

Renders the 'Next' button on the prompt page.
Available only when 'one prompt per page' is rendered.

Renders the next/last incremental fetch buttons.
It determines values for blockEnd and blockInit which are passed as parameters when invoking method renderNextLastIncrementalFetch(MarkupOutput, int, int). These values are calculated by this transform.

Renders the next/last incremental fetch buttons.

Renders the 'Previous' button on the prompt page.
Available only when 'one prompt per page' is rendered.

Renders an individual prompt.

Renders content for a single prompt object by applying given Style.
Based on the xsl name, this method gets a TransformInstance from the style catalog and calls the transform method of that transform. The Transform returned by the style catalog should be an instance of WebPromptTransform. If styleName is empty or null, then prompt's default style (defined in StyleCatalog.xml) gets used.

Renders content for a single prompt object denoted by given index.
It parses prompts collection and if an instance of PromptObject is defined at given index, then method renderPrompt(MarkupOutput, PromptObject) is invoked.

Renders content for a single prompt object.
Wrapper method which invokes method renderPrompt that takes an extra parameter denoting styleName. It passes 'null' value for this parameter which forces renderPrompt method to use prompt's designated style.

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

Renders an individual prompt anchor using the specified index.

Renders Incremental fetch buttons for paginating Prompts being displayed each one in different page.

Renders an individual prompt index.
It generates an HTML anchor formatted with CSS classes.

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

Renders Prompt number based on given index.

Renders Prompt's 'Back to Prompts' button in Summary mode(if available).

Renders 'Prompts summary' toggle area.
Generates display output that denotes an HTML anchor and label to allow end-users to toggle between 'Summary' and 'Questions' prompt's page mode.

Renders prompts area that defines main Prompt's container layout.

Renders content for area designated to show all Prompt questions.
It will iterate prompt list and will render each one of them by calling renderPrompt(MarkupOutput, PromptObject) method.

Renders Prompt index section.
It parses Prompt's collection and for each prompt in it, an HTML formatted index is generated. Function renderPromptIndex(MarkupOutput, PromptObject) is invoked. Also, At the end of this section, an Incremental fetch section gets rendered as well by calling renderNextLastIncrementalFetch(MarkupOutput).

Renders prompts area that defines out-of-box Prompt's container layout.
This function gets executed when not XML layout is defined for given Prompt container.

Renders Prompt's container in Summary mode.
All prompt answers are summarize in this method. No prompt question gets rendered.

Renders hidden input values for all hierarchical prompts specifying a folder Id.

Renders the Save button (if available).

Renders an HTML image TAG for the Prompts Index.

Renders any warning mesage before rendering prompts forms and prompt index.
This warning message is

Renders any warning mesage before rendering prompts forms and prompt index.
This warning message is available in current prompt definition.

Determines whether or not the Prompt Summary header should be visible.
Reads from the levelFlag formal parameter to determine if it should be shown or not when Prompt page is in 'Summary' mode (see isPromptSummaryViewable() method's description.

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

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

Indicates whether or not given prompted report can be cancelled.
A prompted report can be cancelled by end-user if re-prompt is enabled or it isn't a dataset being added to a RW document.

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.

Indicates if the level parameter value contains this flag.

Generates an AnchorTag from given event instance.
Overwrites the parent method by setting special attributes if the event is not provided

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 Prompt's answer event.

Indicates block ending index.
If prompts are displayed in one page and prompts collection doesn't exceed block count, then size of block is returned.

Determines block initial index.
If prompts are displayed in one page and prompts collection doesn't exceed block count, then 0 is returned.

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.

Determines current prompt index.
It takes current prompt object and by parsing collection of prompts, it determines corresponding index.

Returns current prompt's display position.

Indicates current decimal separator for active Locale.

Return the DefaultStyle names to use to render a prompt. This correspond to the same default values used in Microstrategy 7i.

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

Returns argument name for indicating prompt's navigation.
When showing prompts one by one, the name of the argument to navigate through prompts is special, it's always the name of the argument _ the position you want

Indicates prompt's display position.
The display position is different from the PromptPosition. This function properly calculates this value.

Indicates corresponding prompt question transform associated to given style name.
It will return prompt transform defined in StyleCatalog.

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

Returns instance of PromptsBean to be transformed.

Returns the argument name for reprompt action.

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

Determines style name associated to given prompt object.
It searchs for a prompt's displayProperty called STYLE_NAME_PROPERTY. This property corresponds to the name of the xsl set in Microstrategy Desktop. If found the name of the file (without the extension) is returned.
If not found, it calls getDefaultStyleName and return the Default style name.

Initializes property indicating total number of Open prompts in PromptsBean.

Initializes given prompt transform properties before transform given prompt object.
All generic properties that Container needs to inform to each prompt object are specified in this function.

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.

Indicates whether or not to enable Multipart request as encode type content.

Indicates if the request is an action performed in the hierarchical tree prompt.

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.

Indicates whether or not, prompts are loaded for the first time. It looks for any 'prompt' hidden value in request indicating there was a prompt request to be processed. This means, user has started editing any prompt in report.

Specifies incremental fetch properties.
Initializes transform's properties for first, next and last prompts.