Package com.inductiveautomation.ignition.common.alert

Class DefaultAlertEventFilterParams

java.lang.Object

com.inductiveautomation.ignition.common.alert.DefaultAlertEventFilterParams

All Implemented Interfaces:

AlertEventFilterParams, Serializable

public class DefaultAlertEventFilterParams
extends Object
implements AlertEventFilterParams

A simple immutable implementation of AlertEventFilterParams

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultAlertEventFilterParams(String systemFilter, String pathFilter, String displayPathFilter, String stateNameFilter, Integer minSeverityFilter, Integer maxSeverityFilter, boolean activeAndUnacked, boolean activeAndAcked, boolean clearAndUnacked, boolean clearAndAcked)

Method Summary

Modifier and Type	Method	Description
String	getDisplayPathFilter()	Returns the display path filter or null if filter is not specified.
Integer	getMaxSeverityFilter()	Returns the max severity filter or null if filter is not specified.
Integer	getMinSeverityFilter()	Returns the min severity filter or null if filter is not specified.
String	getPathFilter()	Returns the path filter or null if filter is not specified.
String	getStateNameFilter()	Returns the state name filter or null if filter is not specified.
String	getSystemFilter()	Returns the system filter or null if filter is not specified.
boolean	isActiveAndAcked()
boolean	isActiveAndUnacked()
boolean	isClearAndAcked()
boolean	isClearAndUnacked()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultAlertEventFilterParams

public DefaultAlertEventFilterParams(String systemFilter,
 String pathFilter,
 String displayPathFilter,
 String stateNameFilter,
 Integer minSeverityFilter,
 Integer maxSeverityFilter,
 boolean activeAndUnacked,
 boolean activeAndAcked,
 boolean clearAndUnacked,
 boolean clearAndAcked)

Method Details

isActiveAndAcked

public boolean isActiveAndAcked()

Specified by:

isActiveAndAcked in interface AlertEventFilterParams

isActiveAndUnacked

public boolean isActiveAndUnacked()

Specified by:

isActiveAndUnacked in interface AlertEventFilterParams

isClearAndAcked

public boolean isClearAndAcked()

Specified by:

isClearAndAcked in interface AlertEventFilterParams

isClearAndUnacked

public boolean isClearAndUnacked()

Specified by:

isClearAndUnacked in interface AlertEventFilterParams

getMaxSeverityFilter

public Integer getMaxSeverityFilter()

Description copied from interface: AlertEventFilterParams

Returns the max severity filter or null if filter is not specified. If specified, it filters alerts that have severity less than or equal to the given value.

Specified by:

getMaxSeverityFilter in interface AlertEventFilterParams

getMinSeverityFilter

public Integer getMinSeverityFilter()

Description copied from interface: AlertEventFilterParams

Returns the min severity filter or null if filter is not specified. If specified, it filters alerts that have severity greater than or equal to the given value.

Specified by:

getMinSeverityFilter in interface AlertEventFilterParams

getPathFilter

public String getPathFilter()

Description copied from interface: AlertEventFilterParams

Returns the path filter or null if filter is not specified. If specified, it matches the alert's path to the given filter. May include a wildcard character of '%' which means any characters (zero or more).

Specified by:

getPathFilter in interface AlertEventFilterParams

getDisplayPathFilter

public String getDisplayPathFilter()

Description copied from interface: AlertEventFilterParams

Returns the display path filter or null if filter is not specified. If specified, it matches the alert's display path to the given filter. May include a wildcard character of '%' which means any characters (zero or more).

Specified by:

getDisplayPathFilter in interface AlertEventFilterParams

getStateNameFilter

public String getStateNameFilter()

Description copied from interface: AlertEventFilterParams

Returns the state name filter or null if filter is not specified. If specified, it matches the alert's state name to the given filter. May include a wildcard character of '%' which means any characters (zero or more).

Specified by:

getStateNameFilter in interface AlertEventFilterParams

getSystemFilter

public String getSystemFilter()

Description copied from interface: AlertEventFilterParams

Returns the system filter or null if filter is not specified. If specified, it matches the SCADARail system the alert is in to the given filter. May include a wildcard character of '%' which means any characters (zero or more).

Specified by:

getSystemFilter in interface AlertEventFilterParams