Package com.microstrategy.web.beans

Interface EnumPromptDefinitionBeanEvents

  • public interface EnumPromptDefinitionBeanEvents
    Events for the prompt definition bean.
    Since:
    MicroStrategy Web 9.0.0

    • Field Detail

      • PROMPTDEF_EVENT_CHOOSE_PROMPT_TYPE

        static final int PROMPTDEF_EVENT_CHOOSE_PROMPT_TYPE
        This event can be used to choose the prompt type of the prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_REQUIRED

        static final int PROMPTDEF_EVENT_SET_REQUIRED
        Sets the required flag of the prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_MINIMUM

        static final int PROMPTDEF_EVENT_SET_MINIMUM
        Sets the minimum value for the prompt. Uses both the isSet and value parameters - if isSet is not 1, then it is set as no minimum regardless of value.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_MAXIMUM

        static final int PROMPTDEF_EVENT_SET_MAXIMUM
        Sets the maximum value for the prompt. Uses both the isSet and value parameters - if isSet is not 1, then it is set as no maximum regardless of value.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_TITLE

        static final int PROMPTDEF_EVENT_SET_TITLE
        Sets the title of the prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_MEANING

        static final int PROMPTDEF_EVENT_SET_MEANING
        Sets the meaning of the prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_DISPLAY_PROPS

        static final int PROMPTDEF_EVENT_SET_DISPLAY_PROPS
        Sets the display properties of the prompt. This includes the style and whether the style should be a cart or not.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_OBJECTS

        static final int PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_OBJECTS
        Removes the given available list objects. The arguments are either the PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL or PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_DATATYPE

        static final int PROMPTDEF_EVENT_SET_DATATYPE
        Sets the constant datatype of the prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_CST_DEFAULT_ANSWER

        static final int PROMPTDEF_EVENT_SET_CST_DEFAULT_ANSWER
        Sets the default answer for a constant prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_ATTRIBUTE

        static final int PROMPTDEF_EVENT_SET_ATTRIBUTE
        Sets the attribute being qualified upon for an elements prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_ELEMENTS

        static final int PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_ELEMENTS
        Removes elements from the available elements list. Takes two optional arguments: PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST, which specifies the elements to remove, and PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL, which if set to 1 will cause all items to be removed.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_CLEAR_RESTRICTION

        static final int PROMPTDEF_EVENT_CLEAR_RESTRICTION
        Clears the currently set restriction. Requires no arguments.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_ELEMENTS_AVAILABLE_LIST

        static final int PROMPTDEF_EVENT_SET_ELEMENTS_AVAILABLE_LIST
        Takes the PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST argument.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_REMOVE_DEFAULT_ANSWER_ELEMENTS

        static final int PROMPTDEF_EVENT_REMOVE_DEFAULT_ANSWER_ELEMENTS
        Removes elements from the default elements list answer. Takes two optional arguments: PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST, which specifies the elements to remove, and PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL, which if set to 1 will cause all items to be removed.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_SET_OBJECTS_AVAILABLE_LIST

        static final int PROMPTDEF_EVENT_SET_OBJECTS_AVAILABLE_LIST
        Takes the PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST argument.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_CANCEL_PROMPT_BEAN

        static final int PROMPTDEF_EVENT_CANCEL_PROMPT_BEAN
        This event will cancel a currently open prompt bean. The prompt bean will restore the previous answer when this event is called.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_PROMPT_TYPE

        static final int PROMPTDEF_EVENT_ARGUMENT_PROMPT_TYPE
        An argument for the prompt type
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_IS_REQUIRED

        static final int PROMPTDEF_EVENT_ARGUMENT_IS_REQUIRED
        An argument specifying the prompt is required or not.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_IS_SET

        static final int PROMPTDEF_EVENT_ARGUMENT_IS_SET
        An argument specifying whether the option is selected or not.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_VALUE

        static final int PROMPTDEF_EVENT_ARGUMENT_VALUE
        An argument representing the main input value to an event. The context will be obvious based on the event.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_TITLE

        static final int PROMPTDEF_EVENT_ARGUMENT_TITLE
        An argument representing the title of the prompt
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_MEANING

        static final int PROMPTDEF_EVENT_ARGUMENT_MEANING
        An argument representing the meaning/description of the prompt
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_DISPLAY_STYLE

        static final int PROMPTDEF_EVENT_ARGUMENT_DISPLAY_STYLE
        An argument representing the display style of the prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_DISPLAY_ISCART

        static final int PROMPTDEF_EVENT_ARGUMENT_DISPLAY_ISCART
        An argument representing whether the prompt display is a cart or not.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST

        static final int PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST
        A list of objects. The format is a set of objects separated by EnumPromptsBeanEvents.UNIT_SEPARATOR. Each element is composed of (objectID) + EnumPromptsBeanEvents.ITEM_SEPARATOR + (objectType) + EnumPromptsBeanEvents.ITEM_SEPARATOR + (objectName). Note that the final unit separator and name can be omitted, if the display name does not need to be specified.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_DATATYPE

        static final int PROMPTDEF_EVENT_ARGUMENT_DATATYPE
        An argument representing the datatype of a constant prompt.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_ID

        static final int PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_ID
        An argument referring to the ID of an attribute.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_NAME

        static final int PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_NAME
        An argument referring to the name of an attribute.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL

        static final int PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL
        If this argument is passed to an event which supports it, all items will be removed, instead of a discrete list.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST

        static final int PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST
        A list of elements. The format is a set of elements separated by EnumPromptsBeanEvents.UNIT_SEPARATOR. Each element is composed of (elementID) + EnumPromptsBeanEvents.ITEM_SEPARATOR + (display name). Note that the unit separator and name can be omitted, if the display name does not need to be specified.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID

        static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID
        An argument referring to the id of an object.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE

        static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE
        An argument referring to the type of an object. The value is from the EnumDSSXMLObjectTypes
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME

        static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME
        An argument referring to the name of an object.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME

        static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME
        An argument referring to the name of the prompt property name.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE

        static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE
        An argument referring to the value of the prompt property value.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT

        static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT
        An argument referring whether prompt property should set to use default value.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_PROPERTY_SET_NAME

        static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_SET_NAME
        An argument referring to the name of the prompt property set name.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_CUSTOM_FORMS

        static final int PROMPTDEF_EVENT_ARGUMENT_CUSTOM_FORMS
        An argument referring to the list of forms used as custom forms in attribute qualification. The format is a set of attribute forms separated by EnumPromptsBeanEvents.UNIT_SEPARATOR. Each attribute form is composed of (attribute form DSSID) + EnumPromptsBeanEvents.ITEM_SEPARATOR + (attribute form type, 21) + EnumPromptsBeanEvents.ITEM_SEPARATOR + (attribute form display name). Note that the final unit separator and name can be omitted, if the display name does not need to be specified.
        See Also:
        Constant Field Values

      • PROMPTDEF_EVENT_ARGUMENT_OBJECT_SUBTYPE

        static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_SUBTYPE
        An argument referring to the subtype of an object. The value is from the EnumDSSXMLObjectSubTypes
        See Also:
        Constant Field Values