Interface AlarmShelfManager

  • All Known Subinterfaces:
    AlarmManager

    public interface AlarmShelfManager
    • Method Detail

      • isRemote

        boolean isRemote()
        Returns:
        True when manager represents a remote gateway
      • shelve

        java.lang.Boolean shelve​(java.util.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

        java.util.List<ShelvedPath> getShelvedPaths()
        Returns information about all of the alarm paths that are currently shelved.