Package lumis.doui.source.filter

Interface ISourceFilter<S extends Source>

All Known Subinterfaces:

ITableSourceFilter

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 ISourceFilter<S extends Source>

Defines the methods of a 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

Modifier and Type	Method	Description
ISourceFilter<? extends S>	getFilter(String filterId)	Returns the filter with the given id.
String	getInputControlType()	Returns the input control type for this filter doui frontend.
void	init(S source, Node filterNode)	Initialization method, called before any other method on the filter instance.
default boolean	isEnabled()	Returns if this filter is enabled.

Method Detail

init

void init(S source,
          Node filterNode)
   throws PortalException

Initialization method, called before any other method on the filter instance.

Parameters:

source - the source the filter belongs to.

filterNode - the filter definition node.

Throws:

PortalException - if the filter could not initialize itself.

Since:

4.0.5

getFilter

ISourceFilter<? extends S> getFilter(String filterId)
                              throws PortalException

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.

Parameters:

filterId - the filter id.

Returns:

return the filter instance or null if the corresponding filter was not found.

Throws:

PortalException

Since:

4.0.5

getInputControlType

String getInputControlType()
                    throws PortalException

Returns the input control type for this filter doui frontend.

Returns:

the input control type, or null if there is no frontend for this filter instance.

Throws:

PortalException

Since:

4.0.5

isEnabled

default boolean isEnabled()
                   throws PortalException

Returns if this filter is enabled. If not enabled, this filter should be ignored, as if it was not present.

Returns:

true if this filter is enabled, false otherwise.

Throws:

PortalException

Since:

10.4.0