Supported Bean: PromptDefinitionBean
Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_PROMPT_DEFINITION (4097)
Events
| cancelPromptBean | ||||
| This event will cancel a currently open prompt bean. The prompt bean will restore the previous answer when this event is called. |
4097017 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_CANCEL_PROMPT_BEAN |
||
| choosePromptType | ||||
| This event can be used to choose the prompt type of the prompt. |
4097001 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_CHOOSE_PROMPT_TYPE |
||
|
*promptType | An argument for the prompt type |
4097001 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROMPT_TYPE |
|
| clearRestriction | ||||
| Clears the currently set restriction. Requires no arguments. |
4097013 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_CLEAR_RESTRICTION |
||
| delete | ||||
| Event for deleting current user. No parameter. |
1048576001 | |||
| duplicate | ||||
| Event for duplicating current user and refrencing to the duplicated user. No parameter. |
1048576004 |
EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_DUPLICATE |
||
| initAsNew | ||||
| Event for creating a new user. No parameter. |
1048576003 |
EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_INIT_AS_NEW |
||
| refresh | ||||
| Event for refreshing current user. No parameter. |
1048576005 | |||
| removeAvailListElements | ||||
| 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. |
4097012 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_ELEMENTS |
||
|
elementsList | 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. |
4097016 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST |
|
|
removeAll | If this argument is passed to an event which supports it, all items will be removed, instead of a discrete list. |
4097015 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL |
|
| removeAvailListObjects | ||||
| Removes the given available list objects. The arguments are either the PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL or PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST. |
4097008 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_REMOVE_AVAIL_LIST_OBJECTS |
||
|
objectsList | 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. |
4097009 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST |
|
|
removeAll | If this argument is passed to an event which supports it, all items will be removed, instead of a discrete list. |
4097015 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL |
|
| removeDefaultAnswerElements | ||||
| 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. |
4097015 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_REMOVE_DEFAULT_ANSWER_ELEMENTS |
||
|
elementsList | 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. |
4097016 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST |
|
|
removeAll | If this argument is passed to an event which supports it, all items will be removed, instead of a discrete list. |
4097015 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_REMOVE_ALL |
|
| save | ||||
| Event for saving current user. No parameter. |
1048576002 | |||
| setAttribute | ||||
| Sets the attribute being qualified upon for an elements prompt. |
4097011 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_ATTRIBUTE |
||
|
*attributeID | An argument referring to the ID of an attribute. |
4097012 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_ID |
|
|
attributeName | An argument referring to the name of an attribute. |
4097013 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_ATTRIBUTE_NAME |
|
| setAttributeFormDisplay | ||||
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:
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_VALUE -- The value of the argument is one of the values from EnumWebDisplayedForms
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_CUSTOM_FORMS -- a list of custom forms when previous argument's value is of EnumWebDisplayedForms.WebDisplayedFormsCustom |
4097019 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_ATTRIBUTE_FORM_DISPLAY |
||
|
customForms | 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. |
4097024 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_CUSTOM_FORMS |
|
|
value | An argument representing the main input value to an event. The context will be obvious based on the event. |
4097004 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_VALUE |
|
| setConstantDefaultAnswer | ||||
| Sets the default answer for a constant prompt. |
4097010 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_CST_DEFAULT_ANSWER |
||
|
value | An argument representing the main input value to an event. The context will be obvious based on the event. |
4097004 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_VALUE |
|
| setDatatype | ||||
| Sets the constant datatype of the prompt. |
4097009 | |||
|
*datatype | An argument representing the datatype of a constant prompt. |
4097011 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_DATATYPE |
|
| setDisplayProps | ||||
| Sets the display properties of the prompt. This includes the style and whether the style should be a cart or not. |
4097007 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_DISPLAY_PROPS |
||
|
displayStyle | An argument representing the display style of the prompt. |
4097007 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_DISPLAY_STYLE |
|
|
isCart | An argument representing whether the prompt display is a cart or not. |
4097008 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_DISPLAY_ISCART |
|
| setElementsAvailList | ||||
| Takes the PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST argument. |
4097014 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_ELEMENTS_AVAILABLE_LIST |
||
|
elementsList | 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. |
4097016 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_ELEMENTS_LIST |
|
| setElemFilter | ||||
This event will set the filter restriction for the elements prompt.
The following are the arguments to this event.
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME (optional) |
4097022 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_EP_FILTER |
||
|
objectID | An argument referring to the id of an object. |
4097017 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID |
|
|
objectName | An argument referring to the name of an object. |
4097019 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME |
|
|
objectType | An argument referring to the type of an object. The value is from the EnumDSSXMLObjectTypes |
4097018 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE |
|
| setExprOrigin | ||||
This event will set the origin for the expression prompt.
The following are the arguments to this event.
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME (optional)
EnumPromptDefinitionBeanEvents.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). |
4097018 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_EXPR_ORIGIN |
||
|
objectID | An argument referring to the id of an object. |
4097017 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID |
|
|
objectName | An argument referring to the name of an object. |
4097019 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME |
|
|
objectType | An argument referring to the type of an object. The value is from the EnumDSSXMLObjectTypes |
4097018 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE |
|
| setMaximum | ||||
| 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. |
4097004 | |||
|
isSet | An argument specifying whether the option is selected or not. |
4097003 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_IS_SET |
|
|
value | An argument representing the main input value to an event. The context will be obvious based on the event. |
4097004 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_VALUE |
|
| setMeaning | ||||
| Sets the meaning of the prompt. |
4097006 | |||
|
meaning | An argument representing the meaning/description of the prompt |
4097006 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_MEANING |
|
| setMinimum | ||||
| 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. |
4097003 | |||
|
isSet | An argument specifying whether the option is selected or not. |
4097003 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_IS_SET |
|
|
value | An argument representing the main input value to an event. The context will be obvious based on the event. |
4097004 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_VALUE |
|
| setName | ||||
| Event for setting a new name for the object. |
1048576006 | |||
|
name |
1048576001 | |||
| setObjectsAvailList | ||||
| Takes the PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST argument. |
4097016 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_OBJECTS_AVAILABLE_LIST |
||
|
objectsList | 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. |
4097009 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECTS_LIST |
|
| setObjSearch | ||||
This event will set the search restriction for the object prompt.
The following are the arguments to this event.
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME (optional) |
4097021 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_OP_SEARCH |
||
|
objectID | An argument referring to the id of an object. |
4097017 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_ID |
|
|
objectName | An argument referring to the name of an object. |
4097019 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_NAME |
|
|
objectType | An argument referring to the type of an object. The value is from the EnumDSSXMLObjectTypes |
4097018 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_OBJECT_TYPE |
|
| setPromptProperty | ||||
This event sets the prompt property values. This event uses the follwoing arguments:
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME,
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE
and EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT |
4097020 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_SET_PROMPT_PROPERTY |
||
|
propIsDefault | An argument referring whether prompt property should set to use default value. |
4097022 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_IS_DEFAULT |
|
|
propName | An argument referring to the name of the prompt property name. |
4097020 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_NAME |
|
|
propValue | An argument referring to the value of the prompt property value. |
4097021 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_VALUE |
|
|
psName | An argument referring to the name of the prompt property set name. |
4097023 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_PROPERTY_SET_NAME |
|
| setRequired | ||||
| Sets the required flag of the prompt. |
4097002 | |||
|
*isRequired | An argument specifying the prompt is required or not. |
4097002 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_IS_REQUIRED |
|
| setTitle | ||||
| Sets the title of the prompt. |
4097005 | |||
|
title | An argument representing the title of the prompt |
4097005 |
EnumPromptDefinitionBeanEvents.PROMPTDEF_EVENT_ARGUMENT_TITLE |
|
Notes
* denotes required field.