ElementPromptBean (Web API 2021)

All Superinterfaces:

EnumWebPersistableState, Persistable, PromptBean, PromptObject, RequestPersistable, Transformable, WebBean, WebComponent
```
public interface ElementPromptBean
extends PromptBean
```
Interface for the Element Prompt Bean.

Since:

MicroStrategy Web 9.0.0

Field Summary
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addElement(java.lang.String elementID, java.lang.String displayName)`	Add an element to the answer.
`boolean`	`canSupportIncrementalFetch()`	Returns true if the prompt supports incremental fetch.
`boolean`	`canSupportSearch()`	Returns true if the prompt supports search functionality.
`void`	`clearAnswer()`	Clears the answer for the prompt.
`WebElements`	`getAnswer()`	Returns the answer for the element prompt
`boolean`	`isPromptEmpty()`	Returns true if the prompt has no selections to display.
`void`	`removeElement(int key)`	Remove an element based on a key.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.PromptBean
getAvailableItems, getSelectedItems, isXDAMDXPrompt

Methods inherited from interface com.microstrategy.web.beans.PromptObject
getDisplayHelper, getHighlightedObjects, getOriginalSearchRoot, getPromptPosition, getPromptsBean, getPromptsSource, getUserSearchPattern, getValidationInfo, getWebPrompt, hasAnswerChanged, setAnswerChanged, setUserSearchPattern, setValidationInfo

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Method Detail
  - getAnswer
```
WebElements getAnswer()
```
    Returns the answer for the element prompt
    
    Returns:
    
    WebElements collection
  - clearAnswer
```
void clearAnswer()
```
    Clears the answer for the prompt.
  - addElement
```
void addElement(java.lang.String elementID,
                java.lang.String displayName)
```
    Add an element to the answer.
    
    Parameters:
    
    elementID - - the id of the element
    
    displayName - - the display name of the element
  - removeElement
```
void removeElement(int key)
```
    Remove an element based on a key.
    
    Parameters:
    
    key - - key of the element to remove.
  - canSupportSearch
```
boolean canSupportSearch()
```
    Returns true if the prompt supports search functionality.
    
    Returns:
    
    true if the prompt supports search functionality.
  - canSupportIncrementalFetch
```
boolean canSupportIncrementalFetch()
```
    Returns true if the prompt supports incremental fetch.
    
    Returns:
    
    true if the prompt can support incremental fetch.
  - isPromptEmpty
```
boolean isPromptEmpty()
```
    Returns true if the prompt has no selections to display.
    
    Returns:
    
    true if the prompt has no selections to display.