Package com.inductiveautomation.ignition.common.script.builtin

Class AbstractUserUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.AbstractUserUtilities

Direct Known Subclasses:

ClientUserUtilities

public abstract class AbstractUserUtilities
extends Object

Constructor Summary

Constructors

Constructor	Description
AbstractUserUtilities()

Method Summary

Modifier and Type	Method	Description
UIResponse	addCompositeSchedule(String name, String scheduleOne, String scheduleTwo)
UIResponse	addCompositeSchedule(String name, String scheduleOne, String scheduleTwo, String description)
protected abstract UIResponse	addCompositeScheduleImpl(String name, String scheduleOne, String scheduleTwo, String description)
UIResponse	addHoliday(HolidayModel holiday)
protected abstract UIResponse	addHolidayImpl(HolidayModel holiday)
UIResponse	addRole(String userSource, String role)
protected abstract UIResponse	addRoleImpl(String userSource, String role)
UIResponse	addSchedule(AbstractScheduleModel schedule)
protected abstract UIResponse	addScheduleImpl(AbstractScheduleModel schedule)
UIResponse	addUser(String userSource, User user)
protected abstract UIResponse	addUserImpl(String userSource, User user)
ScheduleAdjustment	createScheduleAdjustment(Date startDate, Date endDate, boolean isAvailable, String note)
UIResponse	editHoliday(String holidayName, HolidayModel holiday)
protected abstract UIResponse	editHolidayImpl(String holidayName, HolidayModel holiday)
UIResponse	editRole(String userSource, String oldName, String newName)
protected abstract UIResponse	editRoleImpl(String userSource, String oldName, String newName)
UIResponse	editSchedule(String scheduleName, AbstractScheduleModel schedule)
protected abstract UIResponse	editScheduleImpl(String scheduleName, AbstractScheduleModel schedule)
UIResponse	editUser(String userSource, User user)
protected abstract UIResponse	editUserImpl(String userSource, User user)
HolidayModel	getHoliday(String holidayName)
protected abstract HolidayModel	getHolidayImpl(String holidayName)
List<String>	getHolidayNames()
protected abstract Collection<String>	getHolidayNamesImpl()
List<HolidayModel>	getHolidays()
protected abstract Collection<HolidayModel>	getHolidaysImpl()
User	getNewUser(String userSource, String username)
protected abstract User	getNewUserImpl(String userSource, String username)
List<String>	getRoles(String userSource)
protected abstract Collection<String>	getRolesImpl(String userSource)
AbstractScheduleModel	getSchedule(String scheduleName)
Collection<User>	getScheduledUsers(String userSource)
Collection<User>	getScheduledUsers(String userSource, long date)
Collection<User>	getScheduledUsers(String userSource, Date date)
protected abstract Collection<User>	getScheduledUsersImpl(String userSource, long date)
protected abstract AbstractScheduleModel	getScheduleImpl(String scheduleName)
List<String>	getScheduleNames()
protected abstract Collection<String>	getScheduleNamesImpl()
List<AbstractScheduleModel>	getSchedules()
protected abstract Collection<AbstractScheduleModel>	getSchedulesImpl()
User	getUser(String userSource, String username)
protected abstract User	getUserImpl(String userSource, String username)	Find a specific user based on username.
List<PyUser>	getUsers(String userSource)
protected abstract Collection<User>	getUsersImpl(String userSource)	List all users in a user source
List<org.python.core.PyObject>	getUserSources()
protected abstract Collection<UserSourceMeta>	getUserSourcesImpl()
boolean	isUserScheduled(User user)
boolean	isUserScheduled(User user, long date)
Boolean	isUserScheduled(User user, Date date)
protected abstract Boolean	isUserScheduledImpl(User user, long date)
UIResponse	removeHoliday(String holidayName)
protected abstract UIResponse	removeHolidayImpl(String holidayName)
UIResponse	removeRole(String userSource, String role)
protected abstract UIResponse	removeRoleImpl(String userSource, String role)
UIResponse	removeSchedule(String scheduleName)
protected abstract UIResponse	removeScheduleImpl(String schedule)
UIResponse	removeUser(String userSource, String username)
protected abstract UIResponse	removeUserImpl(String userSource, String username)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractUserUtilities

public AbstractUserUtilities()

Method Details

getUserSourcesImpl

protected abstract Collection<UserSourceMeta> getUserSourcesImpl()
                                                          throws Exception

Throws:

Exception

getUserSources

public List<org.python.core.PyObject> getUserSources()
                                              throws Exception

Throws:

Exception

getUsers

public List<PyUser> getUsers(String userSource)
                      throws Exception

Throws:

Exception

getUser

public User getUser(String userSource,
 String username)
             throws Exception

Throws:

Exception

getNewUser

public User getNewUser(String userSource,
 String username)
                throws Exception

Throws:

Exception

addUser

public UIResponse addUser(String userSource,
 User user)
                   throws Exception

Throws:

Exception

editUser

public UIResponse editUser(String userSource,
 User user)
                    throws Exception

Throws:

Exception

removeUser

public UIResponse removeUser(String userSource,
 String username)
                      throws Exception

Throws:

Exception

addRole

public UIResponse addRole(String userSource,
 String role)
                   throws Exception

Throws:

Exception

editRole

public UIResponse editRole(String userSource,
 String oldName,
 String newName)
                    throws Exception

Throws:

Exception

removeRole

public UIResponse removeRole(String userSource,
 String role)
                      throws Exception

Throws:

Exception

getRoles

public List<String> getRoles(String userSource)
                      throws Exception

Throws:

Exception

getScheduleNames

public List<String> getScheduleNames()
                              throws Exception

Throws:

Exception

getSchedule

@Nullable
public AbstractScheduleModel getSchedule(String scheduleName)
                                  throws Exception

Throws:

Exception

getSchedules

public List<AbstractScheduleModel> getSchedules()
                                         throws Exception

Throws:

Exception

removeSchedule

public UIResponse removeSchedule(String scheduleName)
                          throws Exception

Throws:

Exception

editSchedule

public UIResponse editSchedule(String scheduleName,
 AbstractScheduleModel schedule)
                        throws Exception

Throws:

Exception

addSchedule

public UIResponse addSchedule(AbstractScheduleModel schedule)
                       throws Exception

Throws:

Exception

addCompositeSchedule

public UIResponse addCompositeSchedule(String name,
 String scheduleOne,
 String scheduleTwo)
                                throws Exception

Throws:

Exception

addCompositeSchedule

public UIResponse addCompositeSchedule(String name,
 String scheduleOne,
 String scheduleTwo,
 String description)
                                throws Exception

Throws:

Exception

createScheduleAdjustment

public ScheduleAdjustment createScheduleAdjustment(Date startDate,
 Date endDate,
 boolean isAvailable,
 String note)

getHolidayNames

public List<String> getHolidayNames()
                             throws Exception

Throws:

Exception

getHoliday

public HolidayModel getHoliday(String holidayName)
                        throws Exception

Throws:

Exception

getHolidays

public List<HolidayModel> getHolidays()
                               throws Exception

Throws:

Exception

removeHoliday

public UIResponse removeHoliday(String holidayName)
                         throws Exception

Throws:

Exception

editHoliday

public UIResponse editHoliday(String holidayName,
 HolidayModel holiday)
                       throws Exception

Throws:

Exception

addHoliday

public UIResponse addHoliday(HolidayModel holiday)
                      throws Exception

Throws:

Exception

isUserScheduled

public boolean isUserScheduled(User user)
                        throws Exception

Throws:

Exception

isUserScheduled

public boolean isUserScheduled(User user,
 long date)
                        throws Exception

Throws:

Exception

isUserScheduled

public Boolean isUserScheduled(User user,
 Date date)
                        throws Exception

Throws:

Exception

getScheduledUsers

public Collection<User> getScheduledUsers(String userSource)
                                   throws Exception

Throws:

Exception

getScheduledUsers

public Collection<User> getScheduledUsers(String userSource,
 long date)
                                   throws Exception

Throws:

Exception

getScheduledUsers

public Collection<User> getScheduledUsers(String userSource,
 Date date)
                                   throws Exception

Throws:

Exception

getUsersImpl

protected abstract Collection<User> getUsersImpl(String userSource)
                                          throws Exception

List all users in a user source

Throws:

Exception

getUserImpl

protected abstract User getUserImpl(String userSource,
 String username)
                             throws Exception

Find a specific user based on username. Return null if the user is not found.

Throws:

Exception

getNewUserImpl

protected abstract User getNewUserImpl(String userSource,
 String username)
                                throws Exception

Throws:

Exception

addUserImpl

protected abstract UIResponse addUserImpl(String userSource,
 User user)
                                   throws Exception

Throws:

Exception

editUserImpl

protected abstract UIResponse editUserImpl(String userSource,
 User user)
                                    throws Exception

Throws:

Exception

removeUserImpl

protected abstract UIResponse removeUserImpl(String userSource,
 String username)
                                      throws Exception

Throws:

Exception

addRoleImpl

protected abstract UIResponse addRoleImpl(String userSource,
 String role)
                                   throws Exception

Throws:

Exception

editRoleImpl

protected abstract UIResponse editRoleImpl(String userSource,
 String oldName,
 String newName)
                                    throws Exception

Throws:

Exception

removeRoleImpl

protected abstract UIResponse removeRoleImpl(String userSource,
 String role)
                                      throws Exception

Throws:

Exception

getRolesImpl

protected abstract Collection<String> getRolesImpl(String userSource)
                                            throws Exception

Throws:

Exception

getScheduleImpl

@Nullable
protected abstract AbstractScheduleModel getScheduleImpl(String scheduleName)
                                                  throws Exception

Throws:

Exception

getSchedulesImpl

protected abstract Collection<AbstractScheduleModel> getSchedulesImpl()
                                                               throws Exception

Throws:

Exception

getScheduleNamesImpl

protected abstract Collection<String> getScheduleNamesImpl()
                                                    throws Exception

Throws:

Exception

removeScheduleImpl

protected abstract UIResponse removeScheduleImpl(String schedule)
                                          throws Exception

Throws:

Exception

editScheduleImpl

protected abstract UIResponse editScheduleImpl(String scheduleName,
 AbstractScheduleModel schedule)
                                        throws Exception

Throws:

Exception

addScheduleImpl

protected abstract UIResponse addScheduleImpl(AbstractScheduleModel schedule)
                                       throws Exception

Throws:

Exception

addCompositeScheduleImpl

protected abstract UIResponse addCompositeScheduleImpl(String name,
 String scheduleOne,
 String scheduleTwo,
 String description)
                                                throws Exception

Throws:

Exception

getHolidayImpl

protected abstract HolidayModel getHolidayImpl(String holidayName)
                                        throws Exception

Throws:

Exception

getHolidayNamesImpl

protected abstract Collection<String> getHolidayNamesImpl()
                                                   throws Exception

Throws:

Exception

getHolidaysImpl

protected abstract Collection<HolidayModel> getHolidaysImpl()
                                                     throws Exception

Throws:

Exception

removeHolidayImpl

protected abstract UIResponse removeHolidayImpl(String holidayName)
                                         throws Exception

Throws:

Exception

editHolidayImpl

protected abstract UIResponse editHolidayImpl(String holidayName,
 HolidayModel holiday)
                                       throws Exception

Throws:

Exception

addHolidayImpl

protected abstract UIResponse addHolidayImpl(HolidayModel holiday)
                                      throws Exception

Throws:

Exception

isUserScheduledImpl

protected abstract Boolean isUserScheduledImpl(User user,
 long date)
                                        throws Exception

Throws:

Exception

getScheduledUsersImpl

protected abstract Collection<User> getScheduledUsersImpl(String userSource,
 long date)
                                                   throws Exception

Throws:

Exception