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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected UIResponse
addHolidayImpl(HolidayModel holiday)
protected UIResponse
addRoleImpl(java.lang.String userSource, java.lang.String role)
protected UIResponse
addScheduleImpl(AbstractScheduleModel schedule)
protected UIResponse
addUserImpl(java.lang.String userSource, User user)
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 UIResponse
editUserImpl(java.lang.String userSource, User user)
protected HolidayModel
getHolidayImpl(java.lang.String holidayName)
protected java.util.Collection<java.lang.String>
getHolidayNamesImpl()
protected java.util.Collection<HolidayModel>
getHolidaysImpl()
protected User
getNewUserImpl(java.lang.String userSource, java.lang.String username)
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 sourceprotected 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)
protected UIResponse
removeUserImpl(java.lang.String userSource, java.lang.String username)
-
Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractUserUtilities
addHoliday, addRole, addSchedule, addUser, createScheduleAdjustment, editHoliday, editRole, editSchedule, editUser, getHoliday, getHolidayNames, getHolidays, getNewUser, getRoles, getSchedule, getScheduledUsers, getScheduledUsers, getScheduledUsers, getScheduleNames, getSchedules, getUser, getUsers, isUserScheduled, isUserScheduled, isUserScheduled, removeHoliday, removeRole, removeSchedule, removeUser
-
-
-
-
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 classAbstractUserUtilities
- 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 classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getNewUserImpl
protected User getNewUserImpl(java.lang.String userSource, java.lang.String username) throws java.lang.Exception
- Specified by:
getNewUserImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
addUserImpl
protected UIResponse addUserImpl(java.lang.String userSource, User user) throws java.lang.Exception
- Specified by:
addUserImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
editUserImpl
protected UIResponse editUserImpl(java.lang.String userSource, User user) throws java.lang.Exception
- Specified by:
editUserImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
removeUserImpl
protected UIResponse removeUserImpl(java.lang.String userSource, java.lang.String username) throws java.lang.Exception
- Specified by:
removeUserImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
addRoleImpl
protected UIResponse addRoleImpl(java.lang.String userSource, java.lang.String role) throws java.lang.Exception
- Specified by:
addRoleImpl
in classAbstractUserUtilities
- 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 classAbstractUserUtilities
- Throws:
java.lang.Exception
-
removeRoleImpl
protected UIResponse removeRoleImpl(java.lang.String userSource, java.lang.String role) throws java.lang.Exception
- Specified by:
removeRoleImpl
in classAbstractUserUtilities
- 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 classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getScheduleImpl
@Nullable protected AbstractScheduleModel getScheduleImpl(java.lang.String scheduleName) throws java.lang.Exception
- Specified by:
getScheduleImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getSchedulesImpl
protected java.util.Collection<AbstractScheduleModel> getSchedulesImpl() throws java.lang.Exception
- Specified by:
getSchedulesImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getScheduleNamesImpl
protected java.util.Collection<java.lang.String> getScheduleNamesImpl() throws java.lang.Exception
- Specified by:
getScheduleNamesImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
removeScheduleImpl
protected UIResponse removeScheduleImpl(java.lang.String schedule) throws java.lang.Exception
- Specified by:
removeScheduleImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
editScheduleImpl
protected UIResponse editScheduleImpl(java.lang.String scheduleName, AbstractScheduleModel schedule) throws java.lang.Exception
- Specified by:
editScheduleImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
addScheduleImpl
protected UIResponse addScheduleImpl(AbstractScheduleModel schedule) throws java.lang.Exception
- Specified by:
addScheduleImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getHolidayImpl
protected HolidayModel getHolidayImpl(java.lang.String holidayName) throws java.lang.Exception
- Specified by:
getHolidayImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getHolidayNamesImpl
protected java.util.Collection<java.lang.String> getHolidayNamesImpl() throws java.lang.Exception
- Specified by:
getHolidayNamesImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
getHolidaysImpl
protected java.util.Collection<HolidayModel> getHolidaysImpl() throws java.lang.Exception
- Specified by:
getHolidaysImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
removeHolidayImpl
protected UIResponse removeHolidayImpl(java.lang.String holidayName) throws java.lang.Exception
- Specified by:
removeHolidayImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
editHolidayImpl
protected UIResponse editHolidayImpl(java.lang.String holidayName, HolidayModel holiday) throws java.lang.Exception
- Specified by:
editHolidayImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
addHolidayImpl
protected UIResponse addHolidayImpl(HolidayModel holiday) throws java.lang.Exception
- Specified by:
addHolidayImpl
in classAbstractUserUtilities
- Throws:
java.lang.Exception
-
isUserScheduledImpl
protected java.lang.Boolean isUserScheduledImpl(User user, long date) throws java.lang.Exception
- Specified by:
isUserScheduledImpl
in classAbstractUserUtilities
- 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 classAbstractUserUtilities
- Throws:
java.lang.Exception
-
-