com.inductiveautomation.factorypmi.application.script.builtin

Class ClientUserUtilities

java.lang.Object

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

com.inductiveautomation.factorypmi.application.script.builtin.ClientUserUtilities

public class ClientUserUtilities
extends AbstractUserUtilities

Constructor Summary

Constructors

Constructor and Description
ClientUserUtilities()

Method Summary

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

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

addHoliday, addRole, addSchedule, editHoliday, editRole, editSchedule, getHoliday, getHolidayNames, getHolidays, getRoles, getSchedule, getScheduledUsers, getScheduledUsers, getScheduledUsers, getScheduleNames, getSchedules, getUser, getUsers, isUserScheduled, isUserScheduled, isUserScheduled, removeHoliday, removeRole, removeSchedule

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientUserUtilities

public ClientUserUtilities()

Method Detail

getUsersImpl

protected java.util.Collection<User> getUsersImpl(java.lang.String userSource)
                                           throws java.lang.Exception

Description copied from class: AbstractUserUtilities

List all users in a user source

Specified by:

getUsersImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getUserImpl

protected User getUserImpl(java.lang.String userSource,
                           java.lang.String username)
                    throws java.lang.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:

java.lang.Exception

addRoleImpl

protected UIResponse addRoleImpl(java.lang.String userSource,
                                 java.lang.String role)
                          throws java.lang.Exception

Specified by:

addRoleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

editRoleImpl

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

Specified by:

editRoleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

removeRoleImpl

protected UIResponse removeRoleImpl(java.lang.String userSource,
                                    java.lang.String role)
                             throws java.lang.Exception

Specified by:

removeRoleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getRolesImpl

protected java.util.Collection<java.lang.String> getRolesImpl(java.lang.String userSource)
                                                       throws java.lang.Exception

Specified by:

getRolesImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getScheduleImpl

@Nullable
protected AbstractScheduleModel getScheduleImpl(java.lang.String scheduleName)
                                                   throws java.lang.Exception

Specified by:

getScheduleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getSchedulesImpl

protected java.util.Collection<AbstractScheduleModel> getSchedulesImpl()
                                                                throws java.lang.Exception

Specified by:

getSchedulesImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getScheduleNamesImpl

protected java.util.Collection<java.lang.String> getScheduleNamesImpl()
                                                               throws java.lang.Exception

Specified by:

getScheduleNamesImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

removeScheduleImpl

protected UIResponse removeScheduleImpl(java.lang.String schedule)
                                 throws java.lang.Exception

Specified by:

removeScheduleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

editScheduleImpl

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

Specified by:

editScheduleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

addScheduleImpl

protected UIResponse addScheduleImpl(AbstractScheduleModel schedule)
                              throws java.lang.Exception

Specified by:

addScheduleImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getHolidayImpl

protected HolidayModel getHolidayImpl(java.lang.String holidayName)
                               throws java.lang.Exception

Specified by:

getHolidayImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getHolidayNamesImpl

protected java.util.Collection<java.lang.String> getHolidayNamesImpl()
                                                              throws java.lang.Exception

Specified by:

getHolidayNamesImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getHolidaysImpl

protected java.util.Collection<HolidayModel> getHolidaysImpl()
                                                      throws java.lang.Exception

Specified by:

getHolidaysImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

removeHolidayImpl

protected UIResponse removeHolidayImpl(java.lang.String holidayName)
                                throws java.lang.Exception

Specified by:

removeHolidayImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

editHolidayImpl

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

Specified by:

editHolidayImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

addHolidayImpl

protected UIResponse addHolidayImpl(HolidayModel holiday)
                             throws java.lang.Exception

Specified by:

addHolidayImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

isUserScheduledImpl

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

Specified by:

isUserScheduledImpl in class AbstractUserUtilities

Throws:

java.lang.Exception

getScheduledUsersImpl

protected java.util.Collection<User> getScheduledUsersImpl(java.lang.String userSource,
                                                           long date)
                                                    throws java.lang.Exception

Specified by:

getScheduledUsersImpl in class AbstractUserUtilities

Throws:

java.lang.Exception