Package com.microstrategy.web.app.beans

Interface ElementPickerBean

All Superinterfaces:

AppComponent, Transformable, WebComponent

All Known Implementing Classes:

ElementPickerBeanImpl

public interface ElementPickerBean
extends AppComponent

This interface provides methods for the element picker used in Attribute Qualification Prompts.

Since:

MicroStrategy Web 8.0.1

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
WebDisplayUnits	getAvailableElements()	Return the collection of available elements.
int	getElementBlockBegin()	Returns the block begin for the elements - used by Incremental fetch
int	getElementBlockCount()	Returns the block count for the elements - used by Incremental fetch
int	getElementChildCount()	Returns the child count for the elements - used by Incremental fetch
int	getPromptPosition()	Get the prompt position index in the report.
PromptsBean	getPromptsBean()	Returns the prompts bean associated with this element picker
WebAttributeForm	getQualificationAttributeForm()	Returns the form to be used for qualification.
java.lang.String	getSelectedAttributeId()	Returns the selected attribute on the bean.
java.lang.String	getSelectedOperator()	Returns the selected Operator on the bean.
java.lang.String	getSelectedText()	Returns the selected text.
boolean	isMultiSelectAvailable()	Returns whether the selected operator support multiple selection
void	setPromptPosition(int position)	Set the prompt position index in the report.
void	setSelectedAttributeId(java.lang.String attributeId)	Set the selected attribute on the bean.
void	setSelectedOperator(java.lang.String operator)	Set the selected Operator on the bean.
void	setSelectedText(java.lang.String text)	Set the selected text on the bean.

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

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

setPromptPosition

void setPromptPosition(int position)

Set the prompt position index in the report.

Parameters:

position - int value with the prompt position in the report

getPromptPosition

int getPromptPosition()

Get the prompt position index in the report.

Returns:

int value with the prompt position in the report

setSelectedText

void setSelectedText(java.lang.String text)

Set the selected text on the bean.

Parameters:

text - String the value from the text box

getSelectedText

java.lang.String getSelectedText()

Returns the selected text.

Returns:

String the value from the text box

setSelectedAttributeId

void setSelectedAttributeId(java.lang.String attributeId)

Set the selected attribute on the bean.

Parameters:

attributeId - String the value from the attribute selection list

getSelectedAttributeId

java.lang.String getSelectedAttributeId()

Returns the selected attribute on the bean.

Returns:

String the value from the attribute selection list

setSelectedOperator

void setSelectedOperator(java.lang.String operator)

Set the selected Operator on the bean.

Parameters:

operator - String the value from the Operator pulldown

getSelectedOperator

java.lang.String getSelectedOperator()

Returns the selected Operator on the bean.

Returns:

String the value from the Operator pulldown

getAvailableElements

WebDisplayUnits getAvailableElements()

Return the collection of available elements.

Returns:

WebDisplayUnits collection of available elements

getPromptsBean

PromptsBean getPromptsBean()

Returns the prompts bean associated with this element picker

Returns:

PromptsBean

isMultiSelectAvailable

boolean isMultiSelectAvailable()

Returns whether the selected operator support multiple selection

Returns:

true if the operator supports multiple selection

getElementBlockBegin

int getElementBlockBegin()

Returns the block begin for the elements - used by Incremental fetch

Returns:

int the block begin

getElementBlockCount

int getElementBlockCount()

Returns the block count for the elements - used by Incremental fetch

Returns:

int the block count

getElementChildCount

int getElementChildCount()

Returns the child count for the elements - used by Incremental fetch

Returns:

int the element child count

getQualificationAttributeForm

WebAttributeForm getQualificationAttributeForm()

Returns the form to be used for qualification. This attribute form's value will be used to pick the element's value.

Returns:

WebAttributeForm the form to use for qualification