Package com.inductiveautomation.ignition.gateway.tasks

Class TaskExtensionPointType

java.lang.Object

com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

com.inductiveautomation.ignition.gateway.tasks.TaskExtensionPointType

All Implemented Interfaces:

ExtensionPointType, java.io.Serializable, java.lang.Comparable<ExtensionPointType>

public class TaskExtensionPointType
extends BaseExtensionPointType

Created by colby.clegg on 3/31/2015.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

description, name, typeId

Constructor Summary

Constructors

Constructor	Description
TaskExtensionPointType(TaskType type)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ExtensionPointType o)
ReferenceField<?>	getSettingsRecordForeignKey()	Returns the ReferenceField linking the extension point's settings record to the parent profile record.
RecordMeta<? extends PersistentRecord>	getSettingsRecordType()	Defines a PersistentRecord type that will be used to add type-specific properties.
TaskType	getTaskType()
ConfigPanel	newRecordConfigPanel(PersistentRecord[] records, IConfigPage configPage, ConfigPanel parentPanel)	Creates a new ConfigPanel that will be used when the user creates a new record of this extension point type.

Methods inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

addRecordInstanceActions, findProfileSettingsRecord, getDescription, getName, getTypeId, isEnabled, onRecordDestroyed

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskExtensionPointType

public TaskExtensionPointType(TaskType type)

Method Detail

getTaskType

public TaskType getTaskType()

getSettingsRecordType

public RecordMeta<? extends PersistentRecord> getSettingsRecordType()

Description copied from interface: ExtensionPointType

Defines a PersistentRecord type that will be used to add type-specific properties. Optional. If null is returned, it is assumed that no extra properties are needed for this type of profile.

Returns:

the meta of the settings record type for this object

getSettingsRecordForeignKey

public ReferenceField<?> getSettingsRecordForeignKey()

Description copied from class: BaseExtensionPointType

Returns the ReferenceField linking the extension point's settings record to the parent profile record. Assumes the field name is "Profile". In other words, every Extension Point settings record should have a ReferenceField name "Profile", pointing to its parent profile.

Specified by:

getSettingsRecordForeignKey in interface ExtensionPointType

Overrides:

getSettingsRecordForeignKey in class BaseExtensionPointType

compareTo

public int compareTo(ExtensionPointType o)

Specified by:

compareTo in interface java.lang.Comparable<ExtensionPointType>

Overrides:

compareTo in class BaseExtensionPointType

newRecordConfigPanel

public ConfigPanel newRecordConfigPanel(PersistentRecord[] records,
                                        IConfigPage configPage,
                                        ConfigPanel parentPanel)

Description copied from interface: ExtensionPointType

Creates a new ConfigPanel that will be used when the user creates a new record of this extension point type. Will be shown after the extension point choice panel.

Specified by:

newRecordConfigPanel in interface ExtensionPointType

Overrides:

newRecordConfigPanel in class BaseExtensionPointType

Parameters:

records - Length will be 1 or 2. Index 0 will always contain the master record for the extension point manager. Index 1 will contain the extension-point specific sub-record (if applicable)

configPage - The parent IConfigPage that can be used to navigate to new config panels.

parentPanel - The parent RecordActionTable that should be returned to when the configuration is complete.

Returns:

A new ConfigPanel, or null to indicate that no custom configuration is desired, and a standard RecordEditForm should be used.