Package com.microstrategy.web.app.beans
Interface FilterElementBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameElement
,Persistable
,ReportFrameElement
,RequestPersistable
,Transformable
,ViewBeanParserBean
,WebComponent
- All Known Subinterfaces:
SubsetUnitLimitElementBean
,ViewFilterElementPanelBean
- All Known Implementing Classes:
ViewFilterElementPanelBeanImpl
public interface FilterElementBean extends ViewBeanParserBean, ReportFrameElement
The FilterElement interface represents a filter editor frame element. It is obtained by calling either getViewFilterElement or getReportFilterElement on theReportFrameBean
interface. The FilterElement's target bean is the appropriateExpressionBean
object that refers to the same filter that the element does.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
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 boolean
getAutoApply()
Returns whether auto-apply is enabled.ExpressionBean
getExpressionBean()
This is a shortcut method that returns theExpressionBean
that this FilterElement refers to.int
getFilterType()
boolean
isEditable()
Returns whether the FilterElement is editable.boolean
isViewFilter()
Returns whether this FilterElement is used for a ViewFilter or a ReportFilter.void
setAutoApply(boolean autoApply)
Sets the auto-apply setting.void
setFilterType(int value)
Set the filter type to usevoid
setIsViewFilter(boolean view)
Sets the current View setting for this FilterElement.-
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.app.beans.FrameElement
getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement
getReportFrameBean, isGridDataNecessary
-
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.app.beans.ViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey
-
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, 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, setWebEventHandler
-
-
-
-
Method Detail
-
isEditable
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.
-
getAutoApply
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.
-
setAutoApply
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.
-
getExpressionBean
ExpressionBean getExpressionBean()
This is a shortcut method that returns theExpressionBean
that this FilterElement refers to.- Returns:
- The
ExpressionBean
linked with the FilterElement.
-
isViewFilter
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).
- Since:
- MicroStrategy Web 8.0.1
-
setIsViewFilter
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.- Since:
- MicroStrategy Web 8.0.1
-
getFilterType
int getFilterType()
- Returns:
- int value with the filter type being used.
Values come from the
EnumExpressionBeanType
enumeration - Since:
- MicroStrategy Web 8.0.2
-
setFilterType
void setFilterType(int value)
Set the filter type to use- Parameters:
value
- int with the filter type value to use. Values come from theEnumExpressionBeanType
enumeration- Since:
- MicroStrategy Web 8.0.2
-
-