Package com.inductiveautomation.ignition.gateway.tags.api

Class TagProviderExtensionPointType

java.lang.Object

com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

com.inductiveautomation.ignition.gateway.tags.api.TagProviderExtensionPointType

All Implemented Interfaces:

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

public abstract class TagProviderExtensionPointType
extends BaseExtensionPointType

See Also:

Serialized Form

Field Summary

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

description, name, typeId

Constructor Summary

Constructors

Constructor	Description
TagProviderExtensionPointType(java.lang.String typeId)
TagProviderExtensionPointType(java.lang.String typeId, java.lang.String nameKey, java.lang.String descriptionKey)

Method Summary

Modifier and Type	Method	Description
abstract GatewayTagProvider	createNewProvider(GatewayContext context, TagProviderSettingsRecord settings)	Create a GatewayTagProvider instance.

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

addRecordInstanceActions, compareTo, findProfileSettingsRecord, getDescription, getName, getSettingsRecordForeignKey, getTypeId, isEnabled, newRecordConfigPanel, onRecordDestroyed

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.model.ExtensionPointType

getSettingsRecordType

Constructor Detail

TagProviderExtensionPointType

public TagProviderExtensionPointType(java.lang.String typeId)

TagProviderExtensionPointType

public TagProviderExtensionPointType(java.lang.String typeId,
                                     java.lang.String nameKey,
                                     java.lang.String descriptionKey)

Method Detail

createNewProvider

public abstract GatewayTagProvider createNewProvider(GatewayContext context,
                                                     TagProviderSettingsRecord settings)
                                              throws java.lang.Exception

Create a GatewayTagProvider instance.

Parameters:

context - the GatewayContext.

settings - the TagProviderSettingsRecord.

Returns:

an instance of GatewayTagProvider.

Throws:

java.lang.Exception - if an error occurred instantiating a new GatewayTagProvider instance.