org.qi4j.library.alarm

## Interface AlarmEvent

- All Superinterfaces:
    Composite, ValueComposite
  All Known Implementing Classes:
    AlarmEvent.Mixin

      @Mixins(value=AlarmEvent.Mixin.class)
      public interface AlarmEvent
      extends ValueComposite

  Event for indicating change of AlarmStatus of an AlarmPoint.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `AlarmEvent.Mixin`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Property<String>` | `alarmIdentity()` Returns the identity of the AlarmPoint that generated the event.
    `String` | `description(Locale locale)` Returns a Description of the event in the specified locale.
    `Property<Date>` | `eventTime()` Returns the Time when the event occurred.
    `String` | `name(Locale locale)` Returns the Name of the event.
    `Property<AlarmStatus>` | `newStatus()` Returns the AlarmStatus after the Event.
    `Property<AlarmStatus>` | `oldStatus()` Returns the AlarmStatus prior to the Event.
    `Property<String>` | `systemName()` Returns the Name of the event.

- - ### Method Detail

    - #### alarmIdentity

          Property<String> alarmIdentity()

      Returns the identity of the AlarmPoint that generated the event.
      Returns:
        the AlarmPoint causing this event.

    - #### oldStatus

          Property<AlarmStatus> oldStatus()

      Returns the AlarmStatus prior to the Event.
      Returns:
        the old AlarmStatus prior to this event.

    - #### newStatus

          Property<AlarmStatus> newStatus()

      Returns the AlarmStatus after the Event.
      Returns:
        the new AlarmStatus of the AlarmPoint after this event.

    - #### eventTime

          Property<Date> eventTime()

      Returns the Time when the event occurred.
      Returns:
        the timestamp when this event occurred.

    - #### systemName

          Property<String> systemName()

      Returns the Name of the event. This normally returns the human readable name of the Event, such as activate, deactivate and acknowledge, in the default locale.
      Returns:
        the name of this event in the default locale.

    - #### name

          String name(Locale locale)

      Returns the Name of the event. This normally returns the human readable name of the Event, such as activate, deactivate and acknowledge, in the given locale.
      Parameters:
        `locale` - the locale that the name should be returned in.
      Returns:
        the name of the event in the given locale.

    - #### description

          String description(Locale locale)

      Returns a Description of the event in the specified locale. This normally returns a brief description of the event type, but could/should allow for AlarmPoint specific descriptions for humans to be better informed.
      Parameters:
        `locale` - the locale that the description should be returned in.
      Returns:
        the description of the event in the given locale.