public abstract static class AlarmProxy.Mixin extends Object implements AlarmPoint
AlarmPoint.AlarmPointMixin, AlarmPoint.AlarmState
HasIdentity.HasIdentityMixin
EVENT_ACKNOWLEDGEMENT, EVENT_ACTIVATION, EVENT_BLOCKING, EVENT_DEACTIVATION, EVENT_DISABLING, EVENT_ENABLING, EVENT_UNBLOCKING, STATUS_ACKNOWLEDGED, STATUS_ACTIVATED, STATUS_BLOCKED, STATUS_DEACTIVATED, STATUS_DISABLED, STATUS_NORMAL, STATUS_REACTIVATED, TRIGGER_ACKNOWLEDGE, TRIGGER_ACTIVATE, TRIGGER_BLOCK, TRIGGER_DEACTIVATE, TRIGGER_DISABLE, TRIGGER_ENABLE, TRIGGER_UNBLOCK
IDENTITY_METHOD, IDENTITY_STATE_NAME
Constructor and Description |
---|
Mixin() |
Modifier and Type | Method and Description |
---|---|
void |
acknowledge()
Acknowledges an AlarmPoint.
|
void |
activate()
Activates an AlarmPoint.
|
String |
attribute(String name)
Return the attribute of the given name.
|
List<String> |
attributeNames()
Return all attribute names
|
boolean |
currentCondition()
Get AlarmPoint condition.
|
AlarmStatus |
currentStatus()
Returns the current state of the standard.
|
void |
deactivate()
Deactivates an AlarmPoint.
|
String |
description(Locale locale)
Returns a Description of the AlarmPoint.
|
String |
descriptionInDefaultLocale()
Returns a Description of the AlarmPoint.
|
AlarmHistory |
history()
Returns the AlarmHistory of the standard.
|
String |
name()
Returns the Name of the AlarmPoint.
|
void |
setAttribute(String name,
String value)
Sets the attribute of the given name.
|
void |
trigger(String trigger)
Trigger a state change.
|
void |
updateCondition(boolean condition)
Set AlarmPoint condition.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
alarmClass, category
identity
@UnitOfWorkPropagation(value=REQUIRED) public void trigger(String trigger) throws IllegalArgumentException
AlarmPoint
When the AlarmPoint object receives a trigger, it must consult the AlarmModel and figure out if there is an actual state change occurring and if any AlarmEvents should be fired.
trigger
in interface AlarmPoint
trigger
- The trigger to execute if existing in the AlarmModel.IllegalArgumentException
- if a trigger is not a known one.@UnitOfWorkPropagation(value=REQUIRED) public void activate()
AlarmPoint
Convenience method for:
trigger( "activate" );
activate
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public void deactivate()
AlarmPoint
trigger( "deactivate" );
deactivate
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public void acknowledge()
AlarmPoint
trigger( source, "acknowledge" );
acknowledge
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public boolean currentCondition()
AlarmPoint
currentCondition
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public void updateCondition(boolean condition)
AlarmPoint
updateCondition
in interface AlarmPoint
condition
- Sets the AlarmPoint condition.@UnitOfWorkPropagation(value=REQUIRED) public AlarmStatus currentStatus()
AlarmPoint
currentStatus
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public AlarmHistory history()
AlarmPoint
history
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public List<String> attributeNames()
AlarmPoint
attributeNames
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public String attribute(String name)
AlarmPoint
attribute
in interface AlarmPoint
name
- The name of the attribute to return.@UnitOfWorkPropagation(value=REQUIRED) public void setAttribute(String name, @Optional String value)
AlarmPoint
setAttribute
in interface AlarmPoint
name
- The name of the attribute to set.value
- The value to set the named attribute to.@UnitOfWorkPropagation(value=REQUIRED) public String name()
AlarmPoint
name
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public String descriptionInDefaultLocale()
AlarmPoint
descriptionInDefaultLocale
in interface AlarmPoint
@UnitOfWorkPropagation(value=REQUIRED) public String description(Locale locale)
AlarmPoint
null
, then the
default Locale is used.description
in interface AlarmPoint
locale
- The locale to return the description in, or null to use default locale.