public interface

EnumPromptDefinitionBeanEvents

com.microstrategy.web.beans.EnumPromptDefinitionBeanEvents

Class Overview

Events for the prompt definition bean.

Summary

Constants
int PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_ID An argument referring to the ID of an attribute.
int PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_NAME An argument referring to the name of an attribute.
int PROMPTDEF_EVENT_ARGUMENT_CUSTOM_FORMS An argument referring to the list of forms used as custom forms in attribute qualification.
int PROMPTDEF_EVENT_ARGUMENT_DATATYPE An argument representing the datatype of a constant prompt.
int PROMPTDEF_EVENT_ARGUMENT_DISPLAY_ISCART An argument representing whether the prompt display is a cart or not.
int PROMPTDEF_EVENT_ARGUMENT_DISPLAY_STYLE An argument representing the display style of the prompt.
int PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST A list of elements.
int PROMPTDEF_EVENT_ARGUMENT_IS_REQUIRED An argument specifying the prompt is required or not.
int PROMPTDEF_EVENT_ARGUMENT_IS_SET An argument specifying whether the option is selected or not.
int PROMPTDEF_EVENT_ARGUMENT_MEANING An argument representing the meaning/description of the prompt
int PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST A list of objects.
int PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID An argument referring to the id of an object.
int PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME An argument referring to the name of an object.
int PROMPTDEF_EVENT_ARGUMENT_OBJECT_SUBTYPE An argument referring to the subtype of an object.
int PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE An argument referring to the type of an object.
int PROMPTDEF_EVENT_ARGUMENT_PROMPT_TYPE An argument for the prompt type
int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT An argument referring whether prompt property should set to use default value.
int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME An argument referring to the name of the prompt property name.
int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_SET_NAME An argument referring to the name of the prompt property set name.
int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE An argument referring to the value of the prompt property value.
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.
int PROMPTDEF_EVENT_ARGUMENT_TITLE An argument representing the title of the prompt
int PROMPTDEF_EVENT_ARGUMENT_VALUE An argument representing the main input value to an event.
int PROMPTDEF_EVENT_CANCEL_PROMPT_BEAN This event will cancel a currently open prompt bean.
int PROMPTDEF_EVENT_CHOOSE_PROMPT_TYPE This event can be used to choose the prompt type of the prompt.
int PROMPTDEF_EVENT_CLEAR_RESTRICTION Clears the currently set restriction.
int PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_ELEMENTS Removes elements from the available elements list.
int PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_OBJECTS Removes the given available list objects.
int PROMPTDEF_EVENT_REMOVE_DEFAULT_ANSWER_ELEMENTS Removes elements from the default elements list answer.
int PROMPTDEF_EVENT_SET_ATTRIBUTE Sets the attribute being qualified upon for an elements prompt.
int PROMPTDEF_EVENT_SET_ATTRIBUTE_FORM_DISPLAY This event sets the display settings for the attribute forms being displayed in an Attribute Qualification prompt or a hierarchy prompt.
int PROMPTDEF_EVENT_SET_CST_DEFAULT_ANSWER Sets the default answer for a constant prompt.
int PROMPTDEF_EVENT_SET_DATATYPE Sets the constant datatype of the prompt.
int PROMPTDEF_EVENT_SET_DISPLAY_PROPS Sets the display properties of the prompt.
int PROMPTDEF_EVENT_SET_ELEMENTS_AVAILABLE_LIST Takes the PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST argument.
int PROMPTDEF_EVENT_SET_EP_FILTER This event will set the filter restriction for the elements prompt.
int PROMPTDEF_EVENT_SET_EXPR_ORIGIN This event will set the origin for the expression prompt.
int PROMPTDEF_EVENT_SET_MAXIMUM Sets the maximum value for the prompt.
int PROMPTDEF_EVENT_SET_MEANING Sets the meaning of the prompt.
int PROMPTDEF_EVENT_SET_MINIMUM Sets the minimum value for the prompt.
int PROMPTDEF_EVENT_SET_OBJECTS_AVAILABLE_LIST Takes the PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST argument.
int PROMPTDEF_EVENT_SET_OP_SEARCH This event will set the search restriction for the object prompt.
int PROMPTDEF_EVENT_SET_PROMPT_PROPERTY This event sets the prompt property values.
int PROMPTDEF_EVENT_SET_REQUIRED Sets the required flag of the prompt.
int PROMPTDEF_EVENT_SET_TITLE Sets the title of the prompt.

Constants

public static final int PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_ID

An argument referring to the ID of an attribute.

Constant Value: 4097012 (0x003e83f4)

public static final int PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_NAME

An argument referring to the name of an attribute.

Constant Value: 4097013 (0x003e83f5)

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

Constant Value: 4097024 (0x003e8400)

public static final int PROMPTDEF_EVENT_ARGUMENT_DATATYPE

An argument representing the datatype of a constant prompt.

Constant Value: 4097011 (0x003e83f3)

public static final int PROMPTDEF_EVENT_ARGUMENT_DISPLAY_ISCART

An argument representing whether the prompt display is a cart or not.

Constant Value: 4097008 (0x003e83f0)

public static final int PROMPTDEF_EVENT_ARGUMENT_DISPLAY_STYLE

An argument representing the display style of the prompt.

Constant Value: 4097007 (0x003e83ef)

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

Constant Value: 4097016 (0x003e83f8)

public static final int PROMPTDEF_EVENT_ARGUMENT_IS_REQUIRED

An argument specifying the prompt is required or not.

Constant Value: 4097002 (0x003e83ea)

public static final int PROMPTDEF_EVENT_ARGUMENT_IS_SET

An argument specifying whether the option is selected or not.

Constant Value: 4097003 (0x003e83eb)

public static final int PROMPTDEF_EVENT_ARGUMENT_MEANING

An argument representing the meaning/description of the prompt

Constant Value: 4097006 (0x003e83ee)

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

Constant Value: 4097009 (0x003e83f1)

public static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID

An argument referring to the id of an object.

Constant Value: 4097017 (0x003e83f9)

public static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME

An argument referring to the name of an object.

Constant Value: 4097019 (0x003e83fb)

public static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_SUBTYPE

An argument referring to the subtype of an object. The value is from the EnumDSSXMLObjectSubTypes

Constant Value: 4097025 (0x003e8401)

public static final int PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE

An argument referring to the type of an object. The value is from the EnumDSSXMLObjectTypes

Constant Value: 4097018 (0x003e83fa)

public static final int PROMPTDEF_EVENT_ARGUMENT_PROMPT_TYPE

An argument for the prompt type

Constant Value: 4097001 (0x003e83e9)

public static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT

An argument referring whether prompt property should set to use default value.

Constant Value: 4097022 (0x003e83fe)

public static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME

An argument referring to the name of the prompt property name.

Constant Value: 4097020 (0x003e83fc)

public static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_SET_NAME

An argument referring to the name of the prompt property set name.

Constant Value: 4097023 (0x003e83ff)

public static final int PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE

An argument referring to the value of the prompt property value.

Constant Value: 4097021 (0x003e83fd)

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

Constant Value: 4097015 (0x003e83f7)

public static final int PROMPTDEF_EVENT_ARGUMENT_TITLE

An argument representing the title of the prompt

Constant Value: 4097005 (0x003e83ed)

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

Constant Value: 4097004 (0x003e83ec)

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

Constant Value: 4097017 (0x003e83f9)

public static final int PROMPTDEF_EVENT_CHOOSE_PROMPT_TYPE

This event can be used to choose the prompt type of the prompt.

Constant Value: 4097001 (0x003e83e9)

public static final int PROMPTDEF_EVENT_CLEAR_RESTRICTION

Clears the currently set restriction. Requires no arguments.

Constant Value: 4097013 (0x003e83f5)

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

Constant Value: 4097012 (0x003e83f4)

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

Constant Value: 4097008 (0x003e83f0)

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

Constant Value: 4097015 (0x003e83f7)

public static final int PROMPTDEF_EVENT_SET_ATTRIBUTE

Sets the attribute being qualified upon for an elements prompt.

Constant Value: 4097011 (0x003e83f3)

public static final int PROMPTDEF_EVENT_SET_ATTRIBUTE_FORM_DISPLAY

This event sets the display settings for the attribute forms being displayed in an Attribute Qualification prompt or a hierarchy prompt. This event will not have any effect on other types of prompt. This event uses the following argument: PROMPTDEF_EVENT_ARGUMENT_VALUE -- The value of the argument is one of the values from EnumWebDisplayedForms PROMPTDEF_EVENT_ARGUMENT_CUSTOM_FORMS -- a list of custom forms when previous argument's value is of WebDisplayedFormsCustom

Constant Value: 4097019 (0x003e83fb)

public static final int PROMPTDEF_EVENT_SET_CST_DEFAULT_ANSWER

Sets the default answer for a constant prompt.

Constant Value: 4097010 (0x003e83f2)

public static final int PROMPTDEF_EVENT_SET_DATATYPE

Sets the constant datatype of the prompt.

Constant Value: 4097009 (0x003e83f1)

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

Constant Value: 4097007 (0x003e83ef)

public static final int PROMPTDEF_EVENT_SET_ELEMENTS_AVAILABLE_LIST

Takes the PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST argument.

Constant Value: 4097014 (0x003e83f6)

public static final int PROMPTDEF_EVENT_SET_EP_FILTER

This event will set the filter restriction for the elements prompt. The following are the arguments to this event. PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME (optional)

Constant Value: 4097022 (0x003e83fe)

public static final int PROMPTDEF_EVENT_SET_EXPR_ORIGIN

This event will set the origin for the expression prompt. The following are the arguments to this event. PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME (optional) PROMPTDEF_EVENT_ARGUMENT_OBJECT_SUBTYPE (optional) If this event is called without any arguments, the expression prompt origin would be cleared. This state is valid only for Hierarchical Prompts which lists all hierarchies).

Constant Value: 4097018 (0x003e83fa)

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

Constant Value: 4097004 (0x003e83ec)

public static final int PROMPTDEF_EVENT_SET_MEANING

Sets the meaning of the prompt.

Constant Value: 4097006 (0x003e83ee)

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

Constant Value: 4097003 (0x003e83eb)

public static final int PROMPTDEF_EVENT_SET_OBJECTS_AVAILABLE_LIST

Takes the PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST argument.

Constant Value: 4097016 (0x003e83f8)

public static final int PROMPTDEF_EVENT_SET_OP_SEARCH

This event will set the search restriction for the object prompt. The following are the arguments to this event. PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME (optional)

Constant Value: 4097021 (0x003e83fd)

public static final int PROMPTDEF_EVENT_SET_PROMPT_PROPERTY

This event sets the prompt property values. This event uses the follwoing arguments: PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME, PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE and PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT

Constant Value: 4097020 (0x003e83fc)

public static final int PROMPTDEF_EVENT_SET_REQUIRED

Sets the required flag of the prompt.

Constant Value: 4097002 (0x003e83ea)

public static final int PROMPTDEF_EVENT_SET_TITLE

Sets the title of the prompt.

Constant Value: 4097005 (0x003e83ed)