Package com.appiancorp.suiteapi.process.analytics2

Interface Filter

All Superinterfaces:

Cloneable, DeepCloneable, Serializable

All Known Implementing Classes:

AheadOfScheduleFilter, BaseFilter, BehindScheduleFilter, CompletedAheadOfScheduleFilter, CompletedBehindScheduleFilter, CompletedFilter, DueTodayFilter, LastNCompletedFilter, LastNDaysFilter, NotYetCompletedFilter, OutsideNStandardDeviationsFilter, RunningFilter, SimpleColumnFilter

public interface Filter
extends Serializable, DeepCloneable

The base interface for all filters in analytics. All filters must implement this interface (by extending BaseFilter which implements this interface), and will have the methods contained within. All filters must be referenced from ReportData.getBaseFilters() and QuickFilterItem.getFilters().

Method Summary

Modifier and Type	Method	Description
boolean	getApply()	Gets whether or not the Filter should be applied.
int	getFilterType()	Gets the type of the Filter These are constants that tell the backend what kind of filter this is.
void	setApply(boolean apply_)	Sets whether or not the Filter should be applied.

Methods inherited from interface com.appiancorp.suiteapi.common.DeepCloneable

clone

Method Details

getFilterType

int getFilterType()

Gets the type of the Filter These are constants that tell the backend what kind of filter this is.

Returns:

the type of the Filter. This is one of:

• 0 = SimpleColumnFilter
• 1 = LastNDaysFilter
• 2 = AheadOfScheduleFilter
• 3 = OutsideNStandardDeviationsFilter
• 4 = NotYetCompletedFilter (Deprecated)
• 5 = LastNCompletedFilter
• 6 = CompletedAheadOfScheduleFilter (Deprecated)
• 7 = BehindScheduleFilter
• 8 = DueTodayFilter
• 9 = CompletedFilter
• 10 = RunningFilter

getApply

boolean getApply()

Gets whether or not the Filter should be applied. If it returns false, the filter will not be applied to the report.

Returns:

true if the Filter is applied, false if not

See Also:

• setApply(boolean)

setApply

void setApply(boolean apply_)

Sets whether or not the Filter should be applied.

Parameters:

apply_ - Set to true to apply the Filter, false to not apply it

See Also:

• getApply()