ITableSourceFilter

All Superinterfaces:

ISourceFilter<TableSource>

All Known Implementing Classes:

AbstractTableSourceFilter, ActivityDateFilter, ActivityDateFilter, CommentContentFilter, CommentItTextFilter, CompositeTableSourceFilter, ContentTableSourceFilter, ContentVersionIdReaderTableSourceFilter, CurrentCommunityIdFilter, CurrentDayDateFilter, DatabaseViewFieldFilter, DatabaseViewFormulaEntryFilter, DependentServiceInstanceIdFilter, DependentServiceInstanceIdFilter, DomainScopeFilter, FileManagementPropertiesInterfaceFilter, MetaDataSourceFilter, MonthTableSourceFilter, MyCommunitiesChannelIdFilter, MyLastModifiedDateTimeTableSourceFilter, NextDayDateFilter, ParentJourneyFilter, QuestionnaireListFilter, StatusFilter, SynonymWordFilter, TableSourceFilter, UserJourneyInstanceFilter, VersionFilter, WorklowStateTableSourceFilter
```
@StableMinor(version="14.0",
             sinceVersion="4.0")
public interface ITableSourceFilter
extends ISourceFilter<TableSource>
```
Defines the methods of a table source filter. Implementations of this interface are not expected to be thread-safe.

Since:

4.0.5

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ITableSourceFilter`	`getFilter(String filterId)`	Returns the filter with the given id.
`IQueryFilter`	`getQueryFilter(QueryBase queryBase, IParameters parameters)`	Returns the query filter to be used with the given query.

Methods inherited from interface lumis.doui.source.filter.ISourceFilter
getInputControlType, init, isEnabled

- Method Detail
  - getQueryFilter
```
IQueryFilter getQueryFilter(QueryBase queryBase,
                            IParameters parameters)
                     throws PortalException,
                            RequiredFilterValueException
```
    Returns the query filter to be used with the given query.
    
    Parameters:
    
    queryBase - the query.
    
    parameters - the parameters to be used for the filter.
    
    Returns:
    
    the query filter.
    
    Throws:
    
    RequiredFilterValueException - when a required value for the filter was not given. No results should be shown when this happen.
    
    PortalException
    
    Since:
    
    4.0.5
  - getFilter
```
ITableSourceFilter getFilter(String filterId)
                      throws PortalException
```
    Description copied from interface: ISourceFilter
    
    Returns the filter with the given id. The filter instances should use a chain of responsability with their children to find and return the requested source filter.
    
    Specified by:
    
    getFilter in interface ISourceFilter<TableSource>
    
    Parameters:
    
    filterId - the filter id.
    
    Returns:
    
    return the filter instance or null if the corresponding filter was not found.
    
    Throws:
    
    PortalException