public interface

WebFilterBase

implements Persistable WebObjectInfo
com.microstrategy.web.objects.WebFilterBase
Known Indirect Subclasses

Class Overview

The WebFilterBase interface is the base interface for both WebFilter and WebCustomGroup.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebDisplayHelper getDisplayHelper()
Returns a WebExpressionHelper object linked to this filter.
abstract WebExpression getExpression()
Returns the expression which comprises the filter, as a WebExpression object.
abstract int getFilterType()
Returns the filter type.
abstract void setFilterType(int filterType)
Sets a filter type.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebDisplayHelper getDisplayHelper ()

Returns a WebExpressionHelper object linked to this filter. This object can be used to generate display XML and highlight/select/detail objects.

Returns

public abstract WebExpression getExpression ()

Returns the expression which comprises the filter, as a WebExpression object.

Returns

public abstract int getFilterType ()

Returns the filter type. This value is from EnumDSSXMLFilterType.

Returns
  • The filter type of either a filter or a custom group.

public abstract void setFilterType (int filterType)

Sets a filter type. This value is from EnumDSSXMLFilterType.

Parameters
filterType the filter type of either a filter or a custom group.