Class AlertStorageProfile
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.alert.storage.AlertStorageProfile
-
- All Implemented Interfaces:
AlertMessageHandler
public abstract class AlertStorageProfile extends java.lang.Object implements AlertMessageHandler
AlertStorageProfile is an interface all alert storage implementations must follow
-
-
Constructor Summary
Constructors Constructor Description AlertStorageProfile()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.util.List<AlertEvent>
query(AlertEventFilterParams filterParams, java.util.Date startTimestampFilter, java.util.Date endTimestampFilter, java.lang.String sortOrder)
Queries the alert storage profile for any records that match the given filter elements.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.alert.AlertMessageHandler
receiveAlert
-
-
-
-
Method Detail
-
query
public abstract java.util.List<AlertEvent> query(AlertEventFilterParams filterParams, java.util.Date startTimestampFilter, java.util.Date endTimestampFilter, java.lang.String sortOrder) throws java.lang.Exception
Queries the alert storage profile for any records that match the given filter elements. All filter arguments can be null, which means to not filter by that field. String based filters can include a wildcard character of '%' which means any characters (zero or more)- Parameters:
filterParams
- The AlertEventFilterParams object containing:- system filter
- path filter
- state name filter
- min severity filter
- max severity filter
- active filter
- ackowledged filter
startTimestampFilter
- Matches any alerts who's active time is greater than or equal to the given filter, if specifiedendTimestampFilter
- Matches any alerts who's active time is less than or equal to the given filter, if specifiedsortOrder
- Either "asc" or "desc". If not understood, will default to "desc"- Returns:
- A list of AlertEvent objects
- Throws:
java.lang.Exception
-
-