Package com.inductiveautomation.ignition.gateway.alarming

Interface AlarmQueryProvider

public interface AlarmQueryProvider

This interface can be implemented by an AlarmProvider in order to provide the ability to query alarm status from a different source than the main alarm state model maintained by the gateway.

Method Summary

Modifier and Type	Method	Description
boolean	acknowledge(java.util.UUID eventId, EventData ackData)
AlarmQueryResult	query(AlarmFilter filter)	Queries the status of the alarms, given the filter.

Method Detail

acknowledge

boolean acknowledge(java.util.UUID eventId,
                    EventData ackData)

query

AlarmQueryResult query(AlarmFilter filter)

Queries the status of the alarms, given the filter. Given the filter, the query may not apply at all to this provider- it is the provider's responsibility to determine this. However, even if the query doesn't apply, the provider is expected to return an empty result set, not null.