public interface

FilterElementBean

implements ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.FilterElementBean
Known Indirect Subclasses

Class Overview

The FilterElement interface represents a filter editor frame element. It is obtained by calling either getViewFilterElement or getReportFilterElement on the ReportFrameBean interface. The FilterElement's target bean is the appropriate ExpressionBean object that refers to the same filter that the element does.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract boolean getAutoApply()
Returns whether auto-apply is enabled.
abstract ExpressionBean getExpressionBean()
This is a shortcut method that returns the ExpressionBean that this FilterElement refers to.
abstract int getFilterType()
abstract boolean isEditable()
Returns whether the FilterElement is editable.
abstract boolean isViewFilter()
Returns whether this FilterElement is used for a ViewFilter or a ReportFilter.
abstract void setAutoApply(boolean autoApply)
Sets the auto-apply setting.
abstract void setFilterType(int value)
Set the filter type to use
abstract void setIsViewFilter(boolean view)
Sets the current View setting for this FilterElement.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract boolean getAutoApply ()

Returns whether auto-apply is enabled. If this is true, then any changes to the expression should be applied immediately. This value is tied to a preference.

Returns
  • The current auto-apply setting.

public abstract ExpressionBean getExpressionBean ()

This is a shortcut method that returns the ExpressionBean that this FilterElement refers to.

Returns

public abstract int getFilterType ()

Returns

public abstract boolean isEditable ()

Returns whether the FilterElement is editable. If it is not editable, then the transform should not render any of the manipulation GUI elements to the user.

Returns
  • Whether the user should be able to edit the expression at the current time.

public abstract boolean isViewFilter ()

Returns whether this FilterElement is used for a ViewFilter or a ReportFilter. If this is true, then it is a ViewFilter else it is a ReportFilter.

Returns
  • The current FilterElement mode (View/Report).

public abstract void setAutoApply (boolean autoApply)

Sets the auto-apply setting. This will affect the auto-apply preference for the user.

Parameters
autoApply The new value for the auto-apply flag.

public abstract void setFilterType (int value)

Set the filter type to use

Parameters
value int with the filter type value to use. Values come from the EnumExpressionBeanType enumeration

public abstract void setIsViewFilter (boolean view)

Sets the current View setting for this FilterElement. If this is true, then it is a ViewFilter else it is a ReportFilter.

Parameters
view The current View setting for this FilterElement.