public interface

EnumPromptLevelFlags

com.microstrategy.web.app.transforms.EnumPromptLevelFlags

Class Overview

EnumPromptLevelFlags.

This enumeration file lists all possible values to be used in Level formal parameters. Prompts defines two different Level formal parameters, one for governing Prompt sections and other for governing prompt regions.

  • Prompt regions. Those visual areas defined within prompt container. These areas are: execution bar, questions, summary, index, position and generic error.
  • Prompt sections. Those visual areas defined within a prompt object itself. It's how a single prompt gets broken down into small graphical areas. These areas are: title, meaning, restriction, validation error, content, default, 'Back to Top' image.

Summary

Constants
int LEVEL_DISPLAY_ELEMENT_NO Constant indicating not to display element overridinding any other setting.
int LEVEL_DISPLAY_ELEMENT_USE_DEFAULT Level flag value indicating to use default Level flag for determining whether or not to display a specific element.
int LEVEL_DISPLAY_ELEMENT_YES Constant indicating display element overridinding any other setting.
int LEVEL_SHOW_ALL This flag is used for displaying all sections and regions.
int LEVEL_SHOW_CONTENT Level flag indicating whether or not to show prompt's content.
int LEVEL_SHOW_DEFAULT_ANSWER Level flag indicating whether or not to show prompt's default answer.
int LEVEL_SHOW_ERROR Level flag indicating whether or not to show prompt validation error.
int LEVEL_SHOW_EXECUTE_BUTTONS Level flag indicating whether or not to show 'Execution' buttons bar.
int LEVEL_SHOW_EXECUTE_BUTTONS_BOTTOM Level flag value indicating to show bottom execution bar.
int LEVEL_SHOW_EXECUTE_BUTTONS_TOP Level flag value indicating to show top execution bar.
int LEVEL_SHOW_GENERIC_ERROR Level flag indicating whether or not to show a generic error.
int LEVEL_SHOW_MEANING Level flag indicating whether or not to show prompt meaning message.
int LEVEL_SHOW_PROMPT_INDEX Level flag indicating whether or not to show prompts index.
int LEVEL_SHOW_PROMPT_POSITION Level flag indicating whether or not to show prompt position.
int LEVEL_SHOW_PROMPT_QUESTIONS Level flag indicating whether or not to show questions section.
int LEVEL_SHOW_PROMPT_SUMMARY Level flag indicating whether or not to show prompts summary section.
int LEVEL_SHOW_RESTRICTION Level flag indicating whether or not to show restriction message.
int LEVEL_SHOW_SAVE_BUTTON Level flag value indicating to show 'Save' button in execution bar.
int LEVEL_SHOW_TITLE Level flag indicating whether or not to show prompt title.
int LEVEL_SHOW_TITLE_BACKTOTOP Level flag indicating whether or not to show 'Back to top' image in prompt title.
int LEVEL_SHOW_WARNING_HEADER_MSSG Level flag value indicating to show 'Warning' header message on top of the prompts container.

Constants

public static final int LEVEL_DISPLAY_ELEMENT_NO

Constant indicating not to display element overridinding any other setting.

Constant Value: 2 (0x00000002)

public static final int LEVEL_DISPLAY_ELEMENT_USE_DEFAULT

Level flag value indicating to use default Level flag for determining whether or not to display a specific element.

Constant Value: 3 (0x00000003)

public static final int LEVEL_DISPLAY_ELEMENT_YES

Constant indicating display element overridinding any other setting.

Constant Value: 1 (0x00000001)

public static final int LEVEL_SHOW_ALL

This flag is used for displaying all sections and regions.
Default value for both section and regions. Used for making sure all visible objects get displayed.

Constant Value: 4095 (0x00000fff)

public static final int LEVEL_SHOW_CONTENT

Level flag indicating whether or not to show prompt's content.
Content will be consisted of HTML code defining each of the prompt styles, such as cart-style forms.

Constant Value: 8 (0x00000008)

public static final int LEVEL_SHOW_DEFAULT_ANSWER

Level flag indicating whether or not to show prompt's default answer.
Below prompt content, there's an area where default answer's expression gets rendered in a static text mode.

Constant Value: 32 (0x00000020)

public static final int LEVEL_SHOW_ERROR

Level flag indicating whether or not to show prompt validation error.

Constant Value: 16 (0x00000010)

public static final int LEVEL_SHOW_EXECUTE_BUTTONS

Level flag indicating whether or not to show 'Execution' buttons bar.
Prompts displays at the bottom (and at the top of the report when there are multiple prompts displayed in one page) a execution bar consisted of 'Execute', 'Cancel', 'Next' 'Back' buttons.

Constant Value: 1 (0x00000001)

public static final int LEVEL_SHOW_EXECUTE_BUTTONS_BOTTOM

Level flag value indicating to show bottom execution bar.
This flag will override LEVEL_SHOW_EXECUTE_BUTTONS in Level flag.

Constant Value: 128 (0x00000080)

public static final int LEVEL_SHOW_EXECUTE_BUTTONS_TOP

Level flag value indicating to show top execution bar. This flag will override LEVEL_SHOW_EXECUTE_BUTTONS in Level flag.

Constant Value: 64 (0x00000040)

public static final int LEVEL_SHOW_GENERIC_ERROR

Level flag indicating whether or not to show a generic error.
Generic error is different to validation error. Generic error is displayed in order to inform an error ocurred either answering any prompt or an unexpected error was caused at SDK or backend layers. It's more of an informative error message.

Constant Value: 32 (0x00000020)

public static final int LEVEL_SHOW_MEANING

Level flag indicating whether or not to show prompt meaning message.

Constant Value: 2 (0x00000002)

public static final int LEVEL_SHOW_PROMPT_INDEX

Level flag indicating whether or not to show prompts index.
Prompt index is shown left to prompt content and it's made of a tabular HTML list of all prompt titles with HTML anchors associated to them. These anchors help end-users to navigate all prompts more friendly and give the experience of more control to the user.

Constant Value: 2 (0x00000002)

public static final int LEVEL_SHOW_PROMPT_POSITION

Level flag indicating whether or not to show prompt position.
Prompt position is an index displayed along with each prompt. It's only available when there are multiple prompts to be answered. This index denotes a numeration for easily indentifying multiple prompts.

Constant Value: 16 (0x00000010)

public static final int LEVEL_SHOW_PROMPT_QUESTIONS

Level flag indicating whether or not to show questions section.
This section is where each of the prompts live. This means, this is the layout where single or multiple prompts will be rendered.

Constant Value: 8 (0x00000008)

public static final int LEVEL_SHOW_PROMPT_SUMMARY

Level flag indicating whether or not to show prompts summary section.
Prompts can be displayed in normal o summary modes. Summary mode means to render all prompts in one page without any HTML form, hence, only answers are displayed in a static text view. It gives the user the chance to review answers before executing the report.

Constant Value: 4 (0x00000004)

public static final int LEVEL_SHOW_RESTRICTION

Level flag indicating whether or not to show restriction message.

Constant Value: 4 (0x00000004)

public static final int LEVEL_SHOW_SAVE_BUTTON

Level flag value indicating to show 'Save' button in execution bar.

Constant Value: 256 (0x00000100)

public static final int LEVEL_SHOW_TITLE

Level flag indicating whether or not to show prompt title.

Constant Value: 1 (0x00000001)

public static final int LEVEL_SHOW_TITLE_BACKTOTOP

Level flag indicating whether or not to show 'Back to top' image in prompt title.
When multiple prompts are displayed in one page, an up-arrow image button is displayed at the prompt title level. This image is only displayed beyond first prompt. It'll act as anchor link for scrolling all the way up to the top page.

Constant Value: 64 (0x00000040)

public static final int LEVEL_SHOW_WARNING_HEADER_MSSG

Level flag value indicating to show 'Warning' header message on top of the prompts container.

Constant Value: 512 (0x00000200)