EnumPromptsBeanEvents

Specifies a separator to delimit two answer units in the flat format.

Specifies a separator to delimit expression elements within a expression answer unit for WebExpressionPrompt in the flat format.

A typical expression answer unit contains a WebOperatorNode, a WebShortcutNode or a WebFormShortcutNode, and a list of WebConstantNode. This separator is used to delimit the above three expression elements.

Specifies a separator to delimit each item contained in the string representation of a WebDisplayUnit. A WebDisplayUnit typically has ID, type and displayName and its string representation is just the string concatenation of the three items above in the listed order.

Specifies an event to add new answer units to the existing answer of a PromptObject contained in a PromptsBean.

This event applies to all types of WebPrompt but each type of prompt has different answer unit. For example, the answer unit for a WebConstantPrompt would be a single string; for a WebExpressionPrompt, its answer unit is a sub expression constituting of a WebOperatorNode and one or more operands, each of which is a WebNode in general. Therefore, for different type of WebPrompt, users need to pass in different arguments to constitute a valid prompt answer unit.

The argument PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD holds different items for different type of WebPrompt. For WebObjectsPrompt, it holds a list of objects; for WebElementsPrompt, it holds a list of elements; for WebExpressionPrompt, it holds a list of constant string values for constituting an answer unit, which is a sub expression.

When adding new answer units, this event also allows the users to change the function of root WebOperatorNode to either DssXmlFunctionAnd or DssXmlFunctionOr.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD

• PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
• PROMPTS_EVENT_ARGUMENT_FUNCTION
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_METRIC_ID
• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID

Specifies an event to answer all the PromptObject contained in a PromptsBean.

This event needs the following optional arguments:

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to answer any number of PromptObject contained in a PromptsBean, but leave the rest untouched. This event requires users to specify the prompt positions at which the corresponding PromptObject are going to be answered.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to answer a WebConstantPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to answer a WebDimtyPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to answer a WebElementsPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to answer a WebExpressionPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
• PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR

Specifies an event to answer a WebObjectsPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies a user action to add more prompt answer units.

Specifies a user action to answer a prompt.

Specifies a user action to browse a child WebFolder.

Specifies a user action to browse elements under an attribute.

Specifies a user action to browse a parent WebFolder.

Specifies a user action to cancel answering a prompt.

Specifies a user action to clear the exsiting prompt answers and then add new ones.

Specifies a user action to drill up and down within a hierarchy in a WebExpressionPrompt.

Specifies a user action to highlight a WebDimension.

Specifies a user action to highlight a WebDimensionAttribute in a WebExpressionPrompt.

Specifies a user action to incrementally fetch WebDisplayUnit.

Specifies a user action to remove prompt answer units.

Specifies a user action to search objects by their names.

Specifies a user action to show the prompt summary.

Specifies an argument for the prompt answer units.

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

An integer prompt answer mode from EnumWebPromptAnswerMode

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

Specifies an argument for a WebAttribute or a WebDimensionAttribute.

Specifies an argument for a WebAttribute along with one of its WebAttributeForm, separated by UNIT_SEPARATOR.

Specifies an argument for block begin for incremental fetch.

Specifies an argument for block count for incremental fetch.

Specifies an argument for the browse path in element browsing. An element browsing filter is built based on this path if it is passed in.

Specifies an argument to show the calendar button.

Specifies an argument for a child WebFolder.

Specifies an argument for a dimension.

Specifies an argument not to automatically re-open prompts in the Intelligence Server when all prompts are closed. By default its value is false. A value of True or 1 means the boolean true.

Specifies an argument for the drilled-to WebAttribute.

Specifies an argument for a filter string used in element browsing.

Specifies an argument for the funtion of an WebOperatorNode in a WebExpression.

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

Specifies an argument to go to a particular page for incrementally fetching objects and elements.

Specifies an argument for case-sensitive when building WebFilter.

Option to rename the message of the resulting report or document.

Specifies an argument for a WebMetric.

Specifies an argument for navigating through a PromptsBean.

Specifies an argument describing an object type that is relevant to an event. This value should either be omitted or be from EnumDSSXMLObjectTypes.

Specifies an argument for the original RW document message ID.

Specifies an argument for the prompt answers used in the original RW instance.

Specifies an argument for a parent WebFolder.

Specifies an argument for the prompt answers to the WebElementsPrompt contained in the destination instance.

Specifies an argument for prompt position, a non negative integer.

Speicifies an argument to re-open a closed prompt in Web. One typical usage senario is that a user wants to re-answer a prompt by clicking the browser back button. The default value is 1 or true, meaning to re-open the prompt in Web.

Note, the prompt is re-opened in Web only. The Intelligence Server still keeps the prompt closed, but the new answers are accepted by the Intelligence Server.

Specifies an argument to indicate an EXCLUDE sub-expression in the prompt answer for supporting SAP Variables. Its default value should be false, include, or 0 which means INCLUDE.

Specifies an argument for the searching name.

Specifies an argument for the searching root.

Specifies an argument to submit the prompt answer. The default value is 1 or true meaning to submit the prompt answer.

Specifies an argument for the function of the root node of an expression.

Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.

Specifies an argument for the prompt answer units to remove.

Specifies an argument for user specified string separator.

The argument for the Answer all prompts to indicate that we should use the already set answers saved on the prompt beans effectively ignoring the other arguments PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS, PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT.

Specifies an event to browse elements of a dimension attribute for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. It is similar to the PROMPTS_EVENT_BROWSE_ELEMENTS except that there is no filter associated with the browsing. It is used for browsing a top level attribute in a dimension.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

• PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
• PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to browse WebElement of a WebAttribute for a PromptObject contained in a PromptsBean.

This event applies only to WebElementsPrompt or WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. For WebElementsPrompt, since its origin is a single WebAttribute, no attribute needs to be specified in the RequestKeys; but for WebExpressionPrompt, it requires to pass in both the WebDimension object and its belonging WebDimensionAttribute object to make things clear.

When building WebFilter for filtered element browsing, certain rules are applied when parsing the filter string a user types in on Web browser. In Backus-Naur Form (BNF) notation, the rule can be stated as (starting and trailing whitespace characters are trimed before parsing):

      FilterString    =   Segment 1*(AndOperator Segment)
                      |   Segment 1*(OrOperator Segment)
                      |   "NOT"   Segment
                      |   Segment
      AndOperator     =   "AND"   |   "and"   |   "|"
      OrOperator      =   "OR"    |   "or"    |   ","
      Segment         =   Literal |   NormalString
      Literal         =   """ NormalString """
      NormalString    =   any ASCII character string excluding double quotes

To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while browsing elements. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts element browsing; it would be unacceptable to the users if the event loses prompt answer changes after finishing element browsing.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
• PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
• PROMPTS_EVENT_ARGUMENT_FILTER_STRING
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_MATCH_CASE
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to browse the content of a child WebFolder of the current folder for a PromptObject contained in a PromptsBean.

This event applies only to WebObjectsPrompt, WebDimtyPrompt or WebExpressionPrompt when their origins are a WebSearch object. In fact, the content of the folder to browse is brought back by searching in the project, and this event just changes the searching root on the origin, a WebSearch object.

To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while browsing folder contents. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts browsing; it would be unacceptable to the user if the event loses prompt answer changes after finishing browsing.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to browse the content of a parent WebFolder of the current folder for a PromptObject contained in a PromptsBean.

Very similar to the event PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER, this event applies only to WebObjectsPrompt, WebDimtyPrompt or WebExpressionPrompt when their origins are a WebSearch object. In fact, the content of the folder to browse is brought back by searching in the project, and this event just changes the searching root on the origin, a WebSearch object.

To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while browsing folder contents. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts browsing; it would be unacceptable to the user if the event loses prompt answer changes after finishing browsing.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to cancel answering all PromptObject contained in a PromptsBean.

Validation error is thrown if it is a required prompt.

This event needs no required or optional arguments.

Specifies an event to cancel answering any number of PromptObject contained in a PromptsBean.

Validation error is thrown if it is a required prompt.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

Specifies an event to clear existing prompt answer and add new answer units to a PromptObject contained in a PromptsBean. This event acts exactly as the event PROMPTS_EVENT_ADD_UNITS except that it does an extra thing - clearing existing answer.

This event applies to all types of WebPrompt but each type of prompt has different answer unit. For example, the answer unit for a WebConstantPrompt would be a single string; for a WebExpressionPrompt, its answer unit is a sub expression constituting of a WebOperatorNode and one or more operands, each of which is a WebNode in general. Therefore, for different type of WebPrompt, users need to pass in different arguments to constitute a valid prompt answer unit.

The argument PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD holds different items for different type of WebPrompt. For WebObjectsPrompt, it holds a list of objects; for WebElementsPrompt, it holds a list of elements; for WebExpressionPrompt, it holds a list of constant string values for constituting an answer unit, which is a sub expression.

When adding new answer units, this event also allows the users to change the function of root WebOperatorNode to either DssXmlFunctionAnd or DssXmlFunctionOr.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD

• PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
• PROMPTS_EVENT_ARGUMENT_FUNCTION
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_METRIC_ID
• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID

Specifies an event to clear the user search expression for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

Specifies an event to drill to a WebDimensionAttribute up and down within a hierarchy for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while drilling. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts drilling; it would be unacceptable to the user if the event loses prompt answer changes after finishing drilling.

When drilling down within the hierarchy, this event requires users to specify a list of WebElement from where to drill down Or specify the browse path of that attribute. If the browse path argument is specified, the element list is ignored and the drilling is based on the browse path only. In drilling up, there is no such a requirement. The argument PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD can be used for passing the list of WebElement.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

• PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
• PROMPTS_EVENT_ARGUMENT_BROWSE_PATH

Specifies an event to highlight a WebDimension for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while highlighting. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts highlighting; it would be unacceptable to the user if the event loses prompt answer changes after finishing highlighting.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_DIMENSION_ID

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to highlight a WebDimensionAttribute in a hierarchy for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while highlighting. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts highlighting; it would be unacceptable to the user if the event loses prompt answer changes after finishing highlighting.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to incremental fetch objects, elements, etc. for a PromptObject contained in a PromptsBean.

This event is very tight to the following two events: PROMPTS_EVENT_BROWSE_ELEMENTS and PROMPTS_EVENT_SEARCH_BY_NAME. By specifying arguments like blockBegin and blockCount, a user can incrementally fetch WebDisplayUnit, if the result of element browsing or searching is too large to fit into his GUI component.

To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while fetching incrementally. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts incremental fetching; it would be unacceptable to the user if the event loses prompt answer changes after finishing incremental fetching.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_NAVIGATION

• PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
• PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to navigate through all PromptObject contained in a PromptsBean.

Navigation through a PromptsBean is done by setting the current prompt position to wherever you want to be. The value of the prompt position is appended to the argument name of PROMPTS_EVENT_ARGUMENT_NAVIGATION, separated by the underscore character.

To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while navigating. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts navigating; it would be unacceptable to the user if the event loses prompt answer changes after finishing highlighting.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_NAVIGATION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to process any supported user action for all PromptObject contained in a PromptsBean.

This event does not need the prompt position argument, since it automatically loops through all PromptObject no matter whether the user has performed any action on it.

When looping through the PromptsBean and processing each individual PromptObject, this event looks for any user action supported by the event handler, and then executes the action before it stops processing. Changes to the prompt answer is always checked and processed even though there is no action specified. User action argument, which informs the event what arguments to look for and what to do, has the prefix PROMPTS_EVENT_ARGUMENT_ACTION_ to distinguish from other event arguments.

With no surprise, this event includes almost all the event arguments defined in this interface. Depending on action, users can pass in any partial arguments necessary for this particular action. As a hint to what arguments are necessary, look for those defined in the corresponding smaller event. For example, if the user action is to incrementally fetch objects as specified by the action argument PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH, look for those arguments defined in the corresponding smaller event PROMPTS_EVENT_INCREMENTAL_FETCH. Since changes to prompt answer is always processed, the user is free to pass in new prompt answer along with those incremental fetch arguments, i.e. blockBegin, blockCount.

Although all arguments are optional for the whole event due to supporting of multiple actions within the same event, some of them are really required arguments for a particular action. For example, the event argument PROMPTS_EVENT_ARGUMENT_DIMENSION_ID is a required argument for the user action PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION.

This event needs the following optional arguments:

• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_FILTER_STRING
• PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
• PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
• PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
• PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
• PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
• PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
• PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
• PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
• PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
• PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
• PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
• PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
• PROMPTS_EVENT_ARGUMENT_FUNCTION
• PROMPTS_EVENT_ARGUMENT_METRIC_ID
• PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
• PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
• PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
• PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
• PROMPTS_EVENT_ARGUMENT_NAVIGATION
• PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
• PROMPTS_EVENT_ARGUMENT_MATCH_CASE
• PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
• PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
• PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
• PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION

Specifies an event to process any supported user action for any number of PromptObject contained in a PromptsBean.

This event does exactly the same thing as another event PROMPTS_EVENT_PROCESS_ALL_PROMPTS, except that this event requires prompt positions and only processes those PromptObject whose positions are specified in the RequestKeys.

When processing each individual PromptObject whose position is specified, this event looks for any user action supported by the event handler, and then executes the action before it stops processing. Changes to the prompt answer is always checked and processed even though there is no action specified. User action argument, which informs the event what arguments to look for and what to do, has the prefix PROMPTS_EVENT_ARGUMENT_ACTION_ to distinguish from other event arguments.

With no surprise, this event includes almost all the event arguments defined in this interface. Depending on action, users can pass in any partial arguments necessary for this particular action. As a hint to what arguments are necessary, look for those defined in the corresponding smaller event. For example, if the user action is to incrementally fetch objects as specified by the action argument PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH, look for those arguments defined in the corresponding smaller event PROMPTS_EVENT_INCREMENTAL_FETCH. Since changes to prompt answer is always processed, the user is free to pass in new prompt answer along with those incremental fetch arguments, i.e. blockBegin, blockCount.

Although all arguments are optional for the whole event due to supporting of multiple actions within the same event, some of them are really required arguments for a particular action. For example, the event argument PROMPTS_EVENT_ARGUMENT_DIMENSION_ID is a required argument for the user action PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_FILTER_STRING
• PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
• PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
• PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
• PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
• PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
• PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
• PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
• PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
• PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
• PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
• PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
• PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
• PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
• PROMPTS_EVENT_ARGUMENT_FUNCTION
• PROMPTS_EVENT_ARGUMENT_METRIC_ID
• PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
• PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
• PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
• PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
• PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
• PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
• PROMPTS_EVENT_ARGUMENT_NAVIGATION
• PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
• PROMPTS_EVENT_ARGUMENT_MATCH_CASE
• PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
• PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
• PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
• PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION

Specifies an event to remove answer units from a PromptObject contained in a PromptsBean.

This event applies to all types of WebPrompt. The argument PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE holds the key, an integer number, of the answer unit to be removed.

To remove a WebElement from a WebElementsObjectNode, users need to pass in the keys for both objects, separated by the ITEM_SEPARATOR.

Same as the event PROMPTS_EVENT_ADD_UNITS, when removing units from prompt answer, this event also allows the users to change the function of root WebOperatorNode to either DssXmlFunctionAnd or DssXmlFunctionOr.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
• PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE

• PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR

Specifies an event to search objects by specifying the searching name for a PromptObject contained in a PromptsBean.

This event applies only to WebObjectsPrompt or WebDimtyPrompt. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while searching objects. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts searching; it would be unacceptable to the user if the event loses prompt answer changes after finishing searching.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
• PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
• PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
• PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to show summary of all PromptObject contained in a PromptsBean.

This event is actually a dummy event since it does nothing in it except that it loops through all prompts to process their answers. In DHTML mode where Javascript could be used, it is totally reasonable that a user first moves the prompt answer around by using Javascript, and then wants to show prompt summaries; it would be unacceptable to the user if the event loses prompt answer changes in the prompt summary page.

This event needs the following optional arguments:

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies an event to show summary of any number of PromptObject contained in a PromptsBean.

This event does exactly the same thing as another event PROMPTS_EVENT_PROCESS_ALL_PROMPTS, except that this event requires prompt positions and only processes those PromptObject whose positions are specified in the RequestKeys.

This event is actually a dummy event since it does nothing in it except that it loops through all specified prompts to process their answers. In DHTML mode where Javascript could be used, it is totally reasonable that a user first moves the prompt answer around by using Javascript, and then wants to show prompt summaries; it would be unacceptable to the user if the event loses prompt answer changes in the prompt summary page.

This event needs the following required arguments:

• PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

• PROMPTS_EVENT_ARGUMENT_ANSWER
• PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
• PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

Specifies a simple separator to delimit an element ID and its element display name in the URL prompt answer for WebElementsPrompt.

The element displayName should be URL encoded with UTF-8 format to avoid any URL unfriendly characters.

Specifies a simple separator to delimit two string constant values. The string constant should not contain the comma character ','.

This separator can be used as the substitution of the SIMPLE_SEPARATOR_SEMICOLON only when the prompt is a WebExpressionPrompt with its expression type of DssXmlFilterAttributeDESCQual or DssXmlFilterAttributeIDQual when the operator is DssXmlFunctionIn.

Specifies a simple separator to delimit two string constant values. The string constant should not contain the semicolon character ';'.

Specifies a separator to delimit two WebDisplayUnit, each of which is represented as a string concatenation of ID, type, and displayName.