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

Class ScheduleExtensionPoint<S>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint<S>

com.inductiveautomation.ignition.gateway.alarming.schedule.ScheduleExtensionPoint<S>

All Implemented Interfaces:

ExtensionPoint<S>, Comparable<ExtensionPoint<S>>

public abstract class ScheduleExtensionPoint<S>
extends AbstractExtensionPoint<S>

The extension point for creating schedules.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

ExtensionPoint.ComponentType

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

descriptionKey, gson, nameKey, typeId, validator

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

PROFILE_KEY, SETTINGS_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScheduleExtensionPoint(String typeId, String nameKey, String descriptionKey)

Method Summary

Modifier and Type	Method	Description
Schedule	createSchedule(GatewayContext context, DecodedResource<ExtensionPointConfig<ScheduleProfileConfig,?>> resource)
abstract Schedule	createSchedule(GatewayContext context, String name, S settings)	Create a new schedule implementation from the given settings.
abstract AbstractScheduleModel	createScheduleModel(GatewayContext context, DecodedResource<ExtensionPointConfig<ScheduleProfileConfig,?>> resource)	Create the schedule model, which is used by the Vision module's schedule management component.
abstract S	createSettingsObject(AbstractScheduleModel model)	Create the settings configuration object for the given model.
final ResourceType	resourceType()	The resource type shared by all types of this extension point.

Methods inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

addReferenceProperty, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceProperties, getSettingsValidator, name, typeId, validate

Methods inherited from class java.lang.Object

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

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

canCreate, compareTo, defaultSettings, getMenuActions, getSettings, getWebUiComponent, settingsSchema, settingsType

Constructor Details

ScheduleExtensionPoint

protected ScheduleExtensionPoint(String typeId,
 String nameKey,
 String descriptionKey)

Method Details

resourceType

public final ResourceType resourceType()

Description copied from interface: ExtensionPoint

The resource type shared by all types of this extension point. This is used to group extension points together. For example, all alarm journal types would share the same resource type, but have different typeIds.

createSchedule

public Schedule createSchedule(GatewayContext context,
 DecodedResource<ExtensionPointConfig<ScheduleProfileConfig,?>> resource)

createSchedule

public abstract Schedule createSchedule(GatewayContext context,
 String name,
 S settings)

Create a new schedule implementation from the given settings. This schedule is the actual implementation of the schedule that determines whether the schedule is active for any given instant.

createScheduleModel

public abstract AbstractScheduleModel createScheduleModel(GatewayContext context,
 DecodedResource<ExtensionPointConfig<ScheduleProfileConfig,?>> resource)

Create the schedule model, which is used by the Vision module's schedule management component.

createSettingsObject

public abstract S createSettingsObject(@Nonnull
 AbstractScheduleModel model)

Create the settings configuration object for the given model.