org.qi4j.library.alarm
Class AlarmEvent.Mixin

java.lang.Object
  extended by org.qi4j.library.alarm.AlarmEvent.Mixin
All Implemented Interfaces:
Composite, ValueComposite, AlarmEvent
Enclosing interface:
AlarmEvent

public abstract static class AlarmEvent.Mixin
extends java.lang.Object
implements AlarmEvent


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.qi4j.library.alarm.AlarmEvent
AlarmEvent.Mixin
 
Constructor Summary
AlarmEvent.Mixin()
           
 
Method Summary
 java.lang.String description(java.util.Locale locale)
          Returns a Description of the event in the specified locale.
 java.lang.String name(java.util.Locale locale)
          Returns the Name of the event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.qi4j.library.alarm.AlarmEvent
alarmIdentity, eventTime, newStatus, oldStatus, systemName
 

Constructor Detail

AlarmEvent.Mixin

public AlarmEvent.Mixin()
Method Detail

name

public java.lang.String name(java.util.Locale locale)
Description copied from interface: AlarmEvent
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.

Specified by:
name in interface AlarmEvent
Parameters:
locale - the locale that the name should be returned in.
Returns:
the name of the event in the given locale.

description

public java.lang.String description(java.util.Locale locale)
Description copied from interface: AlarmEvent
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.

Specified by:
description in interface AlarmEvent
Parameters:
locale - the locale that the description should be returned in.
Returns:
the description of the event in the given locale.