Package com.microstrategy.web.objects
Interface WebFilterBase
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
- All Known Subinterfaces:
WebCustomGroup
,WebFilter
public interface WebFilterBase extends WebObjectInfo, Persistable
- Since:
- MicroStrategy Web 8.1.0
-
-
Field Summary
-
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 WebDisplayHelper
getDisplayHelper()
Returns aWebExpressionHelper
object linked to this filter.WebExpression
getExpression()
Returns the expression which comprises the filter, as aWebExpression
object.int
getFilterType()
Returns the filter type.void
setFilterType(int filterType)
Sets a filter type.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
Method Detail
-
getFilterType
int getFilterType()
Returns the filter type. This value is fromEnumDSSXMLFilterType
.- Returns:
- The filter type of either a filter or a custom group.
-
setFilterType
void setFilterType(int filterType)
Sets a filter type. This value is fromEnumDSSXMLFilterType
.- Parameters:
filterType
- the filter type of either a filter or a custom group.
-
getExpression
WebExpression getExpression()
Returns the expression which comprises the filter, as aWebExpression
object.- Returns:
- The
WebExpression
object corresponding to this filter.
-
getDisplayHelper
WebDisplayHelper getDisplayHelper()
Returns aWebExpressionHelper
object linked to this filter. This object can be used to generate display XML and highlight/select/detail objects.- Returns:
- A
WebExpressionHelper
object which is linked to this filter.
-
-