Interface AlarmQueryResult

  • All Superinterfaces:
    java.util.Collection<AlarmEvent>, java.lang.Iterable<AlarmEvent>, java.util.List<AlarmEvent>
    All Known Implementing Classes:
    AlarmQueryResultImpl

    public interface AlarmQueryResult
    extends java.util.List<AlarmEvent>
    This is the result of a query against the alarming system, for both status and history. It provides the results as a list, but also provides additional helper functions for getting the event and associated data as a dataset.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Dataset getAssociatedData​(java.lang.String uuid)
      Returns the associated data of an event as a dataset.
      Dataset getDataset()
      Returns the alarms as a dataset.
      AlarmEvent getEvent​(java.lang.String uuid)
      Returns the actual AlarmEvent object for the specified event uuid.
      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray
      • Methods inherited from interface java.lang.Iterable

        forEach
      • Methods inherited from interface java.util.List

        add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray
    • Method Detail

      • getDataset

        Dataset getDataset()
        Returns the alarms as a dataset. The specific columns depend on whether this is the result of a status query, or history query.

        History: EventId, Source, DisplayPath, EventTime, EventState, Priority, IsSystemEvent
        Status: EventId, Source, DisplayPath, EventTime, State, Priority

      • getAssociatedData

        Dataset getAssociatedData​(java.lang.String uuid)
        Returns the associated data of an event as a dataset. The columns are [PropertyName, Value]
      • getEvent

        AlarmEvent getEvent​(java.lang.String uuid)
        Returns the actual AlarmEvent object for the specified event uuid.