Package com.inductiveautomation.ignition.alarming.roster

Interface RosterManager

  • public interface RosterManager

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addUsers​(java.lang.String rosterName, java.util.List<User> users, UICallback ui)
      Adds one or more users to an existing roster without deleting existing users.
      void deleteRosters​(java.util.List<java.lang.String> names, UICallback ui)  
      void editRoster​(java.lang.String name, java.util.List<User> users, UICallback ui)
      Deletes all existing users in a roster, then adds all users in the user list.
      java.util.List<User> getRoster​(java.lang.String name)
      Return the ordered list of users in this roster
      java.util.List<java.lang.String> getRosters()
      Return a list of all defined on-call roster names
      void removeUsers​(java.lang.String rosterName, java.util.List<User> users, UICallback ui)
      Removes one or more users from an existing roster.

    • Method Detail

      • getRosters

        java.util.List<java.lang.String> getRosters()
        Return a list of all defined on-call roster names

      • getRoster

        java.util.List<User> getRoster​(java.lang.String name)
        Return the ordered list of users in this roster

      • editRoster

        void editRoster​(java.lang.String name,
                java.util.List<User> users,
                UICallback ui)
        Deletes all existing users in a roster, then adds all users in the user list.
        Parameters:
        name - Not null
        users - Not null, but may be empty
        ui - Nullable

      • addUsers

        void addUsers​(@Nonnull
              java.lang.String rosterName,
              @Nonnull
              java.util.List<User> users,
              @Nullable
              UICallback ui)
        Adds one or more users to an existing roster without deleting existing users.
        Parameters:
        rosterName - Name of roster to add to
        users - List of users to add. May be empty, which is effectively a no-op
        ui - UICallback for error reporting. May be null.

      • removeUsers

        void removeUsers​(@Nonnull
                 java.lang.String rosterName,
                 @Nonnull
                 java.util.List<User> users,
                 @Nullable
                 UICallback ui)
        Removes one or more users from an existing roster.
        Parameters:
        rosterName - Name of roster to remove from
        users - List of users to remove. May be empty, which is effectively a no-op
        ui - UICallback for error reporting. May be null.

      • deleteRosters

        void deleteRosters​(java.util.List<java.lang.String> names,
                   UICallback ui)