Package com.microstrategy.web.app.transforms

Interface EnumPromptLevelFlags

  • public interface EnumPromptLevelFlags

    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.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • LEVEL_SHOW_TITLE

        static final int LEVEL_SHOW_TITLE
        Level flag indicating whether or not to show prompt title.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_MEANING

        static final int LEVEL_SHOW_MEANING
        Level flag indicating whether or not to show prompt meaning message.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_RESTRICTION

        static final int LEVEL_SHOW_RESTRICTION
        Level flag indicating whether or not to show restriction message.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_CONTENT

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_ERROR

        static final int LEVEL_SHOW_ERROR
        Level flag indicating whether or not to show prompt validation error.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_DEFAULT_ANSWER

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_TITLE_BACKTOTOP

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_EXECUTE_BUTTONS

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_PROMPT_INDEX

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_PROMPT_SUMMARY

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_PROMPT_QUESTIONS

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_PROMPT_POSITION

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_GENERIC_ERROR

        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.
        See Also:
        Constant Field Values

      • LEVEL_SHOW_EXECUTE_BUTTONS_TOP

        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.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • LEVEL_SHOW_EXECUTE_BUTTONS_BOTTOM

        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.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • LEVEL_SHOW_SAVE_BUTTON

        static final int LEVEL_SHOW_SAVE_BUTTON
        Level flag value indicating to show 'Save' button in execution bar.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • LEVEL_SHOW_WARNING_HEADER_MSSG

        static final int LEVEL_SHOW_WARNING_HEADER_MSSG
        Level flag value indicating to show 'Warning' header message on top of the prompts container.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • LEVEL_SHOW_ALL

        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.
        See Also:
        Constant Field Values

      • LEVEL_DISPLAY_ELEMENT_YES

        static final int LEVEL_DISPLAY_ELEMENT_YES
        Constant indicating display element overridinding any other setting.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • LEVEL_DISPLAY_ELEMENT_NO

        static final int LEVEL_DISPLAY_ELEMENT_NO
        Constant indicating not to display element overridinding any other setting.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • LEVEL_DISPLAY_ELEMENT_USE_DEFAULT

        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.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values