Package com.microstrategy.web.beans
Interface FilterBean
-
- All Superinterfaces:
EditableBean
,EditableObjectBean
,EnumWebPersistableState
,ObjectBean
,Persistable
,RequestPersistable
,Transformable
,WebBean
,WebComponent
public interface FilterBean extends EditableObjectBean
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
VIEWMODE_BROWSE
View mode of browsing.static int
VIEWMODE_EDIT
View mode of editing.-
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 WebExpression
getExpression()
ExpressionBean
getExpressionBean()
This is a shortcut method that returns theExpressionBean
that this FilterElement refers to.int
getViewMode()
Returns the view mode, a value ofVIEWMODE_BROWSE
orVIEWMODE_EDIT
.void
setViewMode(int mode)
Sets the view mode, a value ofVIEWMODE_BROWSE
orVIEWMODE_EDIT
.-
Methods inherited from interface com.microstrategy.web.beans.EditableBean
delete, duplicate, InitAsNew, refresh, save
-
Methods inherited from interface com.microstrategy.web.beans.EditableObjectBean
getFolderId, isNew, saveAs, setFolderId, setIsNew
-
Methods inherited from interface com.microstrategy.web.beans.ObjectBean
getBlockBegin, getBlockCount, getDisplayName, getFlags, getLevel, getObjectID, getObjectInfo, getObjectName, getObjectType, getParentFolderBean, getParentFolderBean, getParentID, setBlockBegin, setBlockCount, setFlags, setLevel, setObjectID, setObjectInfo, setObjectName, setObjectType
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
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
-
-
-
-
Field Detail
-
VIEWMODE_BROWSE
static final int VIEWMODE_BROWSE
View mode of browsing. In this mode, bean only need to populate some basic object information. In this mode, the bean will assume no change made to the bean and only save limited information in the state, which is enough for it to re-populate the information from backend.- See Also:
- Constant Field Values
-
VIEWMODE_EDIT
static final int VIEWMODE_EDIT
View mode of editing. In this mode, bean will populate all information relate to this object for editing. During the saving state, it will check whether the bean has been modified to decide how to save the state. Any change to the bean will be saved and restored later.- See Also:
- Constant Field Values
-
-
Method Detail
-
getExpression
WebExpression getExpression() throws WebBeanException
- Throws:
WebBeanException
-
getExpressionBean
ExpressionBean getExpressionBean()
This is a shortcut method that returns theExpressionBean
that this FilterElement refers to.- Returns:
- The
ExpressionBean
linked with the FilterElement.
-
getViewMode
int getViewMode()
Returns the view mode, a value ofVIEWMODE_BROWSE
orVIEWMODE_EDIT
. view mode will affect the way the bean to populat and to save the state.- Returns:
- int The view mode.
-
setViewMode
void setViewMode(int mode)
Sets the view mode, a value ofVIEWMODE_BROWSE
orVIEWMODE_EDIT
.- Parameters:
mode
- int The new view mode.- See Also:
getViewMode()
-
-