Package com.inductiveautomation.ignition.gateway.alarming

Interface AlarmShelfManager

All Known Subinterfaces:

AlarmManager

public interface AlarmShelfManager

Method Summary

Modifier and Type	Method	Description
List<ShelvedPath>	getShelvedPaths()	Returns information about all of the alarm paths that are currently shelved.
boolean	isRemote()
Boolean	shelve(Collection<Path> paths, int timeoutSeconds, QualifiedPath userId)	Marks the alarms specified provided paths as shelved.

Method Details

isRemote

boolean isRemote()

Returns:

True when manager represents a remote gateway

shelve

Boolean shelve(Collection<Path> paths,
 int timeoutSeconds,
 QualifiedPath userId)

Marks the alarms specified provided paths as shelved. Can also be used to cancel shelving, by providing a timeout time of 0 seconds. It is not possible to permanently shelve alarms, though large values for the timeout are accepted.

Parameters:

userId - the path describing the user who performed the shelve operation.

getShelvedPaths

List<ShelvedPath> getShelvedPaths()

Returns information about all of the alarm paths that are currently shelved.