Package com.inductiveautomation.ignition.client.script

Class ClientAlarmUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities

com.inductiveautomation.ignition.client.script.ClientAlarmUtilities

public class ClientAlarmUtilities
extends AbstractAlarmUtilities

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities

AbstractAlarmUtilities.PyAlarmEventAdapter

Constructor Summary

Constructors

Constructor	Description
ClientAlarmUtilities()

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.util.UUID>	acknowledge(java.lang.String[] alarmIds, java.lang.String notes)
protected void	cancelImpl(java.util.Set<java.util.UUID> almIds)
java.util.List<ShelvedPath>	getShelvedPaths()
protected java.util.List<AlarmEvent>	queryJournalImpl(java.lang.String journalName, AlarmFilter filter)
protected java.util.List<AlarmEvent>	queryStatusImpl(AlarmFilter filter)
protected void	shelveImpl(java.util.Collection<Path> paths, int timeoutSeconds)

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities

addPropSubCondition, cancel, createFilter, getPaths, processPathCondition, processStringEnumCondition, queryJournal, queryStatus, shelve, unshelve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientAlarmUtilities

public ClientAlarmUtilities()

Method Detail

getShelvedPaths

public java.util.List<ShelvedPath> getShelvedPaths()
                                            throws java.lang.Exception

Specified by:

getShelvedPaths in class AbstractAlarmUtilities

Throws:

java.lang.Exception

queryStatusImpl

protected java.util.List<AlarmEvent> queryStatusImpl(AlarmFilter filter)
                                              throws java.lang.Exception

Specified by:

queryStatusImpl in class AbstractAlarmUtilities

Throws:

java.lang.Exception

queryJournalImpl

protected java.util.List<AlarmEvent> queryJournalImpl(java.lang.String journalName,
                                                      AlarmFilter filter)
                                               throws java.lang.Exception

Specified by:

queryJournalImpl in class AbstractAlarmUtilities

Throws:

java.lang.Exception

shelveImpl

protected void shelveImpl(java.util.Collection<Path> paths,
                          int timeoutSeconds)
                   throws java.lang.Exception

Specified by:

shelveImpl in class AbstractAlarmUtilities

Throws:

java.lang.Exception

cancelImpl

protected void cancelImpl(java.util.Set<java.util.UUID> almIds)
                   throws java.lang.Exception

Specified by:

cancelImpl in class AbstractAlarmUtilities

Throws:

java.lang.Exception

acknowledge

public java.util.Set<java.util.UUID> acknowledge(java.lang.String[] alarmIds,
                                                 java.lang.String notes)
                                          throws java.lang.Exception

Throws:

java.lang.Exception