Package com.inductiveautomation.ignition.client.script

Class ClientUserUtilities

java.lang.Object

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

com.inductiveautomation.ignition.client.script.ClientUserUtilities

public class ClientUserUtilities
extends AbstractUserUtilities

Constructor Summary

Constructors

Constructor	Description
ClientUserUtilities()

Method Summary

Modifier and Type	Method	Description
protected UIResponse	addCompositeScheduleImpl(String name, String scheduleOne, String scheduleTwo, String description)
protected UIResponse	addHolidayImpl(HolidayModel holiday)
protected UIResponse	addRoleImpl(String userSource, String role)
protected UIResponse	addScheduleImpl(AbstractScheduleModel schedule)
protected UIResponse	addUserImpl(String userSource, User user)
protected UIResponse	editHolidayImpl(String holidayName, HolidayModel holiday)
protected UIResponse	editRoleImpl(String userSource, String oldName, String newName)
protected UIResponse	editScheduleImpl(String scheduleName, AbstractScheduleModel schedule)
protected UIResponse	editUserImpl(String userSource, User user)
protected HolidayModel	getHolidayImpl(String holidayName)
protected Collection<String>	getHolidayNamesImpl()
protected Collection<HolidayModel>	getHolidaysImpl()
protected User	getNewUserImpl(String userSource, String username)
protected Collection<String>	getRolesImpl(String userSource)
protected Collection<User>	getScheduledUsersImpl(String userSource, long date)
protected AbstractScheduleModel	getScheduleImpl(String scheduleName)
protected Collection<String>	getScheduleNamesImpl()
protected Collection<AbstractScheduleModel>	getSchedulesImpl()
protected User	getUserImpl(String userSource, String username)	Find a specific user based on username.
protected Collection<User>	getUsersImpl(String userSource)	List all users in a user source
protected Collection<UserSourceMeta>	getUserSourcesImpl()
protected Boolean	isUserScheduledImpl(User user, long date)
protected UIResponse	removeHolidayImpl(String holidayName)
protected UIResponse	removeRoleImpl(String userSource, String role)
protected UIResponse	removeScheduleImpl(String schedule)
protected UIResponse	removeUserImpl(String userSource, String username)

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractUserUtilities

addCompositeSchedule, addCompositeSchedule, addHoliday, addRole, addSchedule, addUser, createScheduleAdjustment, editHoliday, editRole, editSchedule, editUser, getHoliday, getHolidayNames, getHolidays, getNewUser, getRoles, getSchedule, getScheduledUsers, getScheduledUsers, getScheduledUsers, getScheduleNames, getSchedules, getUser, getUsers, getUserSources, isUserScheduled, isUserScheduled, isUserScheduled, removeHoliday, removeRole, removeSchedule, removeUser

Methods inherited from class java.lang.Object

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

Constructor Details

ClientUserUtilities

public ClientUserUtilities()

Method Details

getUserSourcesImpl

protected Collection<UserSourceMeta> getUserSourcesImpl()
                                                 throws Exception

Specified by:

getUserSourcesImpl in class AbstractUserUtilities

Throws:

Exception

getUsersImpl

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

Description copied from class: AbstractUserUtilities

List all users in a user source

Specified by:

getUsersImpl in class AbstractUserUtilities

Throws:

Exception

getUserImpl

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

Description copied from class: AbstractUserUtilities

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

Specified by:

getUserImpl in class AbstractUserUtilities

Throws:

Exception

getNewUserImpl

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

Specified by:

getNewUserImpl in class AbstractUserUtilities

Throws:

Exception

addUserImpl

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

Specified by:

addUserImpl in class AbstractUserUtilities

Throws:

Exception

editUserImpl

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

Specified by:

editUserImpl in class AbstractUserUtilities

Throws:

Exception

removeUserImpl

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

Specified by:

removeUserImpl in class AbstractUserUtilities

Throws:

Exception

addRoleImpl

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

Specified by:

addRoleImpl in class AbstractUserUtilities

Throws:

Exception

editRoleImpl

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

Specified by:

editRoleImpl in class AbstractUserUtilities

Throws:

Exception

removeRoleImpl

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

Specified by:

removeRoleImpl in class AbstractUserUtilities

Throws:

Exception

getRolesImpl

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

Specified by:

getRolesImpl in class AbstractUserUtilities

Throws:

Exception

getScheduleImpl

@Nullable
protected AbstractScheduleModel getScheduleImpl(String scheduleName)
                                         throws Exception

Specified by:

getScheduleImpl in class AbstractUserUtilities

Throws:

Exception

getSchedulesImpl

protected Collection<AbstractScheduleModel> getSchedulesImpl()
                                                      throws Exception

Specified by:

getSchedulesImpl in class AbstractUserUtilities

Throws:

Exception

getScheduleNamesImpl

protected Collection<String> getScheduleNamesImpl()
                                           throws Exception

Specified by:

getScheduleNamesImpl in class AbstractUserUtilities

Throws:

Exception

removeScheduleImpl

protected UIResponse removeScheduleImpl(String schedule)
                                 throws Exception

Specified by:

removeScheduleImpl in class AbstractUserUtilities

Throws:

Exception

editScheduleImpl

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

Specified by:

editScheduleImpl in class AbstractUserUtilities

Throws:

Exception

addScheduleImpl

protected UIResponse addScheduleImpl(AbstractScheduleModel schedule)
                              throws Exception

Specified by:

addScheduleImpl in class AbstractUserUtilities

Throws:

Exception

addCompositeScheduleImpl

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

Specified by:

addCompositeScheduleImpl in class AbstractUserUtilities

Throws:

Exception

getHolidayImpl

protected HolidayModel getHolidayImpl(String holidayName)
                               throws Exception

Specified by:

getHolidayImpl in class AbstractUserUtilities

Throws:

Exception

getHolidayNamesImpl

protected Collection<String> getHolidayNamesImpl()
                                          throws Exception

Specified by:

getHolidayNamesImpl in class AbstractUserUtilities

Throws:

Exception

getHolidaysImpl

protected Collection<HolidayModel> getHolidaysImpl()
                                            throws Exception

Specified by:

getHolidaysImpl in class AbstractUserUtilities

Throws:

Exception

removeHolidayImpl

protected UIResponse removeHolidayImpl(String holidayName)
                                throws Exception

Specified by:

removeHolidayImpl in class AbstractUserUtilities

Throws:

Exception

editHolidayImpl

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

Specified by:

editHolidayImpl in class AbstractUserUtilities

Throws:

Exception

addHolidayImpl

protected UIResponse addHolidayImpl(HolidayModel holiday)
                             throws Exception

Specified by:

addHolidayImpl in class AbstractUserUtilities

Throws:

Exception

isUserScheduledImpl

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

Specified by:

isUserScheduledImpl in class AbstractUserUtilities

Throws:

Exception

getScheduledUsersImpl

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

Specified by:

getScheduledUsersImpl in class AbstractUserUtilities

Throws:

Exception