Class BaseFilter
java.lang.Object
com.appiancorp.suiteapi.process.analytics2.BaseFilter
- All Implemented Interfaces:
DeepCloneable
,Filter
,Serializable
,Cloneable
- Direct Known Subclasses:
AheadOfScheduleFilter
,BehindScheduleFilter
,CompletedAheadOfScheduleFilter
,CompletedBehindScheduleFilter
,CompletedFilter
,DueTodayFilter
,LastNCompletedFilter
,LastNDaysFilter
,NotYetCompletedFilter
,OutsideNStandardDeviationsFilter
,RunningFilter
,SimpleColumnFilter
Base class for all analytics filters. All filters should extend this
class and implement the
getFilterType()
method.
All filters must have a corresponding implementation on the back end.
All filters must be referenced from ReportData.getBaseFilters()
and QuickFilterItem.getFilters()
.- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone this object.boolean
Is this Filter equal to another object?boolean
getApply()
Returnstrue
if the filter should be applied andfalse
otherwise.abstract int
Gets the type of theFilter
These are constants that tell the backend what kind of filter this is.int
hashCode()
Hash code.void
setApply
(boolean apply_) Sets whether or not theFilter
should be applied.
-
Field Details
-
LOG
protected static final org.apache.log4j.Logger LOG
-
-
Constructor Details
-
BaseFilter
public BaseFilter()
-
-
Method Details
-
getFilterType
public abstract int getFilterType()Description copied from interface:Filter
Gets the type of theFilter
These are constants that tell the backend what kind of filter this is.- Specified by:
getFilterType
in interfaceFilter
- 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
- 0 =
-
equals
Is this Filter equal to another object? -
hashCode
public int hashCode()Hash code. -
clone
Clone this object.- Specified by:
clone
in interfaceDeepCloneable
- Overrides:
clone
in classObject
- Returns:
-
getApply
public boolean getApply()Returnstrue
if the filter should be applied andfalse
otherwise. -
setApply
public void setApply(boolean apply_) Description copied from interface:Filter
Sets whether or not theFilter
should be applied.
-