Package com.inductiveautomation.ignition.common.user.rpc

Interface ScheduleRpc

public interface ScheduleRpc

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
UIResponse	addCompositeSchedule(Locale locale, String name, String scheduleOne, String scheduleTwo, String description)
UIResponse	addSchedule(Locale locale, AbstractScheduleModel model)
UIResponse	editSchedule(Locale locale, String originalName, AbstractScheduleModel model)
List<User>	getScheduledUsers(String userSource, long date)
AbstractScheduleModel	getScheduleModel(String scheduleName)
List<AbstractScheduleModel>	getScheduleModels()
List<String>	getScheduleNames()
boolean	isUserScheduled(User user, long date)
UIResponse	removeSchedule(Locale locale, String schedule)
UIResponse	removeSchedules(Locale locale, List<String> schedules)

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Method Details

getScheduleNames

List<String> getScheduleNames()

getScheduleModel

AbstractScheduleModel getScheduleModel(String scheduleName)

getScheduleModels

List<AbstractScheduleModel> getScheduleModels()

addSchedule

UIResponse addSchedule(Locale locale,
 AbstractScheduleModel model)

addCompositeSchedule

UIResponse addCompositeSchedule(Locale locale,
 String name,
 String scheduleOne,
 String scheduleTwo,
 String description)

editSchedule

UIResponse editSchedule(Locale locale,
 String originalName,
 AbstractScheduleModel model)

removeSchedules

UIResponse removeSchedules(Locale locale,
 List<String> schedules)

removeSchedule

UIResponse removeSchedule(Locale locale,
 String schedule)

isUserScheduled

boolean isUserScheduled(User user,
 long date)

getScheduledUsers

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

Throws:

Exception