Package com.inductiveautomation.ignition.common.rpc.impl

Interface AlarmingRpc

public interface AlarmingRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	AlarmingRpc.IsAlarmActiveFilteredRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER	Base Serializer for Alarming-related classes.

Method Summary

Modifier and Type	Method	Description
Set<UUID>	acknowledge(Set<UUID> alarmIds, long timestamp, String notes)
void	cancel(Set<UUID> alarmIds)
List<String>	getAlarmJournals()
List<AlarmProperty<?>>	getExtendedConfigProperties()
List<ShelvedPath>	getShelvedPaths()
QualifiedValue	isAlarmActive(String tagPath, String alarmName)
QualifiedValue	isAlarmActiveFiltered(AlarmingRpc.IsAlarmActiveFilteredRequest request)
List<AlarmEvent>	queryJournal(String profile, AlarmFilter filter)
List<AlarmEvent>	queryStatus(AlarmFilter filter)
Boolean	shelve(List<Path> paths, int timeoutSeconds)

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Base Serializer for Alarming-related classes. We're falling back to Java serialization here because some of the Alarming-related objects (AlarmEvents, for example) extend PropertySets and reference Property types as well. Translating some of these things is a bear, and we can come back later to write a more robust serialization strategy.

Method Details

getShelvedPaths

List<ShelvedPath> getShelvedPaths()

queryStatus

List<AlarmEvent> queryStatus(AlarmFilter filter)

queryJournal

List<AlarmEvent> queryJournal(String profile,
 AlarmFilter filter)

getAlarmJournals

List<String> getAlarmJournals()

shelve

Boolean shelve(List<Path> paths,
 int timeoutSeconds)

cancel

void cancel(Set<UUID> alarmIds)

acknowledge

Set<UUID> acknowledge(Set<UUID> alarmIds,
 long timestamp,
 String notes)

getExtendedConfigProperties

List<AlarmProperty<?>> getExtendedConfigProperties()

isAlarmActive

QualifiedValue isAlarmActive(String tagPath,
 String alarmName)
                      throws ResourceCollectionNotFoundException,
IOException,
IllegalArgumentException

Throws:

ResourceCollectionNotFoundException

IOException

IllegalArgumentException

isAlarmActiveFiltered

QualifiedValue isAlarmActiveFiltered(AlarmingRpc.IsAlarmActiveFilteredRequest request)
                              throws ResourceCollectionNotFoundException,
IllegalArgumentException,
IOException

Throws:

ResourceCollectionNotFoundException

IllegalArgumentException

IOException