public interface

ElementPickerBean

implements AppComponent
com.microstrategy.web.app.beans.ElementPickerBean
Known Indirect Subclasses

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract WebDisplayUnits getAvailableElements()
Return the collection of available elements.
abstract int getElementBlockBegin()
Returns the block begin for the elements - used by Incremental fetch
abstract int getElementBlockCount()
Returns the block count for the elements - used by Incremental fetch
abstract int getElementChildCount()
Returns the child count for the elements - used by Incremental fetch
abstract int getPromptPosition()
Get the prompt position index in the report.
abstract PromptsBean getPromptsBean()
Returns the prompts bean associated with this element picker
abstract WebAttributeForm getQualificationAttributeForm()
Returns the form to be used for qualification.
abstract String getSelectedAttributeId()
Returns the selected attribute on the bean.
abstract String getSelectedOperator()
Returns the selected Operator on the bean.
abstract String getSelectedText()
Returns the selected text.
abstract boolean isMultiSelectAvailable()
Returns whether the selected operator support multiple selection
abstract void setPromptPosition(int position)
Set the prompt position index in the report.
abstract void setSelectedAttributeId(String attributeId)
Set the selected attribute on the bean.
abstract void setSelectedOperator(String operator)
Set the selected Operator on the bean.
abstract void setSelectedText(String text)
Set the selected text on the bean.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract WebDisplayUnits getAvailableElements ()

Return the collection of available elements.

Returns
  • WebDisplayUnits collection of available elements

public abstract int getElementBlockBegin ()

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

Returns
  • int the block begin

public abstract int getElementBlockCount ()

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

Returns
  • int the block count

public abstract int getElementChildCount ()

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

Returns
  • int the element child count

public abstract int getPromptPosition ()

Get the prompt position index in the report.

Returns
  • int value with the prompt position in the report

public abstract PromptsBean getPromptsBean ()

Returns the prompts bean associated with this element picker

Returns
  • PromptsBean

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

public abstract String getSelectedAttributeId ()

Returns the selected attribute on the bean.

Returns
  • String the value from the attribute selection list

public abstract String getSelectedOperator ()

Returns the selected Operator on the bean.

Returns
  • String the value from the Operator pulldown

public abstract String getSelectedText ()

Returns the selected text.

Returns
  • String the value from the text box

public abstract boolean isMultiSelectAvailable ()

Returns whether the selected operator support multiple selection

Returns
  • true if the operator supports multiple selection

public abstract void setPromptPosition (int position)

Set the prompt position index in the report.

Parameters
position int value with the prompt position in the report

public abstract void setSelectedAttributeId (String attributeId)

Set the selected attribute on the bean.

Parameters
attributeId String the value from the attribute selection list

public abstract void setSelectedOperator (String operator)

Set the selected Operator on the bean.

Parameters
operator String the value from the Operator pulldown

public abstract void setSelectedText (String text)

Set the selected text on the bean.

Parameters
text String the value from the text box