Package com.i2group.disco.alerts

Interface ISendTo

All Known Implementing Classes:
SendTo
public interface ISendTo
A set of criteria that determine the list of users to whom an alert is sent.

Users receive the alert if they match any of the criteria. For example, if getUsers() returns ["user1"] and getGroups() returns ["groupA","groupB"], then a user with the principal name user1 matches regardless of group membership, and a user who is a member of groupA matches regardless of membership of groupB (or any other group).

Note: A user must have logged into the system before an alert can be sent to them.

Since:
12.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getCommandPermissions()
    Gets the names of command access control permissions whose owners are to receive the alert.
    Set<String>
    getGroups()
    Gets the names of specific groups of users to receive the alert.
    Set<String>
    getUsers()
    Gets the principal names of specific users to receive the alert.
    boolean
    isSendToAll()
    Indicates whether all users are to receive the alert.

  • Method Details

    • getUsers

      Set<String> getUsers()
      Gets the principal names of specific users to receive the alert.
      Returns:
      See above, or null if this criterion is not used.

    • getGroups

      Set<String> getGroups()
      Gets the names of specific groups of users to receive the alert.
      Returns:
      See above, or null if this criterion is not used.

    • getCommandPermissions

      Set<String> getCommandPermissions()
      Gets the names of command access control permissions whose owners are to receive the alert.
      Returns:
      See above, or null if this criterion is not used.

    • isSendToAll

      boolean isSendToAll()
      Indicates whether all users are to receive the alert.
      Returns:
      true if the alert is to go to all users, overriding any other criteria. false if the other criteria take precedence.