org.apache.polygene.library.alarm

Class AlarmEvent.Mixin

java.lang.Object

org.apache.polygene.library.alarm.AlarmEvent.Mixin

All Implemented Interfaces:

HasIdentity, AlarmEvent

Enclosing interface:

AlarmEvent

public abstract static class AlarmEvent.Mixin
extends Object
implements AlarmEvent

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.polygene.library.alarm.AlarmEvent

AlarmEvent.Mixin

Nested classes/interfaces inherited from interface org.apache.polygene.api.identity.HasIdentity

HasIdentity.HasIdentityMixin

Field Summary

Fields inherited from interface org.apache.polygene.api.identity.HasIdentity

IDENTITY_METHOD, IDENTITY_STATE_NAME

Constructor Summary

Constructors

Constructor and Description
Mixin()

Method Summary

Modifier and Type	Method and Description
String	description(Locale locale) Returns a Description of the event in the specified locale.
String	name(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.apache.polygene.library.alarm.AlarmEvent

eventTime, identity, newStatus, oldStatus, systemName

Constructor Detail

Mixin

public Mixin()

Method Detail

name

public String name(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 String description(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.