Package com.inductiveautomation.reporting.designer.api

Interface QueryConfigFactory

All Known Implementing Classes:
AbstractQueryConfigFactory
public interface QueryConfigFactory
This is the designer-scoped interface that 3rd party module authors need to implement to add new query types. If you create a new instance of this class, make sure and register it with the DesignerDataSourceRegistry
Since:
7.8.0

  • Method Details

    • getId

      String getId()
      Return a unique ID for this type of query. Must match the ID of a QueryType registered in the Gateway

    • getDisplayName

      String getDisplayName()
      A human friendly name for this type of query

    • getTooltip

      String getTooltip()
      An optional string for a tooltip for this query

    • getDefaultDataKey

      String getDefaultDataKey()
      A string to use as the default "Data Key" name for this query

    • newConfigObject

      QueryConfig newConfigObject()
      Create a new, unconfigured copy of the object used to store the configuration of an instance of this query. Must not return null. This object must be both java.io.Serializable and XML serializable (public constructor, getter/setter pairs)

    • createConfigPanel

      QueryConfigPanel createConfigPanel(DesignerContext context, ReportResource report, QueryConfig configObject)
      Create a new QueryConfigPanel which will be used to display and alter the configuration of a config object.