Package com.inductiveautomation.ignition.gateway.alarming.schedule

Interface ScheduleManager

All Superinterfaces:

ExtensionPointManager<ScheduleExtensionPoint<?>>

public interface ScheduleManager
extends ExtensionPointManager<ScheduleExtensionPoint<?>>

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	HOLIDAY_RESOURCE_TYPE
static final ResourceType	SCHEDULE_RESOURCE_TYPE

Method Summary

Modifier and Type	Method	Description
void	addHoliday(HolidayModel newHoliday, UICallback ui)
void	addSchedule(AbstractScheduleModel model, UICallback ui)
boolean	checkSchedule(@Nullable String schedule, long date)	Checks to see if the schedule named is active or not at the given time.
boolean	checkSchedule(String schedule, Date date)	Checks to see if the schedule named is active or not at the given time.
void	editHoliday(String originalName, HolidayModel holiday, UICallback ui)
void	editSchedule(String originalName, AbstractScheduleModel model, UICallback ui)
default ResourceType	getExtensionPointResourceType()
@Nullable HolidayModel	getHoliday(String holidayName)
@NonNull List<HolidayModel>	getHolidays()
AbstractScheduleModel	getScheduleModel(String schedule)	Returns the model of the named schedule
List<String>	getSchedules()	Return a list of all defined schedules
boolean	isScheduleDefined(String schedule)	Checks to see if there is a schedule with the given name.
void	removeHoliday(String holidayName, UICallback ui)
void	removeSchedule(String name, UICallback ui)

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPointManager

getExtensionPointCollection

Field Details

SCHEDULE_RESOURCE_TYPE

static final ResourceType SCHEDULE_RESOURCE_TYPE

HOLIDAY_RESOURCE_TYPE

static final ResourceType HOLIDAY_RESOURCE_TYPE

Method Details

getExtensionPointResourceType

default ResourceType getExtensionPointResourceType()

Specified by:

getExtensionPointResourceType in interface ExtensionPointManager<ScheduleExtensionPoint<?>>

checkSchedule

boolean checkSchedule(String schedule,
 Date date)

Checks to see if the schedule named is active or not at the given time. If the schedule doesn't exist, false will be returned.

checkSchedule

boolean checkSchedule(@Nullable String schedule,
 long date)

Checks to see if the schedule named is active or not at the given time. If the schedule doesn't exist, false will be returned.

isScheduleDefined

boolean isScheduleDefined(String schedule)

Checks to see if there is a schedule with the given name. Names are case insensitive.

getSchedules

List<String> getSchedules()

Return a list of all defined schedules

getScheduleModel

AbstractScheduleModel getScheduleModel(String schedule)

Returns the model of the named schedule

removeSchedule

void removeSchedule(String name,
 UICallback ui)

addSchedule

void addSchedule(AbstractScheduleModel model,
 UICallback ui)

editSchedule

void editSchedule(String originalName,
 AbstractScheduleModel model,
 UICallback ui)

getHolidays

@NonNull List<HolidayModel> getHolidays()

getHoliday

@Nullable HolidayModel getHoliday(String holidayName)

removeHoliday

void removeHoliday(String holidayName,
 UICallback ui)

addHoliday

void addHoliday(HolidayModel newHoliday,
 UICallback ui)

editHoliday

void editHoliday(String originalName,
 HolidayModel holiday,
 UICallback ui)