Package com.inductiveautomation.ignition.alarming.roster

Interface RosterManager

public interface RosterManager

Method Summary

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

Method Details

getRosters

List<String> getRosters()

Return a list of all defined on-call roster names

getRoster

List<User> getRoster(String name)

Return the ordered list of users in this roster

editRoster

void editRoster(String name,
 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
 String rosterName,
 @Nonnull
 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
 String rosterName,
 @Nonnull
 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(List<String> names,
 UICallback ui)