Package de.xima.fc.plugin.config

Interface IBasicConfigParam

All Known Subinterfaces:
IBundleConfigParam, IPluginConfigParam
All Known Implementing Classes:
AConfigParam, BundleConfigGroupItem, BundleConfigParam, PluginConfigGroupItem, PluginConfigParam
public interface IBasicConfigParam
Base interface for the available configuration parameters of a plugin bundle. Each plugin bundle may provide a set of parameters that are then shown on the UI.
Author:
XIMA MEDIA GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultValue()
    Ermöglicht die Festlegung eines Defaultwertes, der als initialer Parameterwert gesetzt werden soll.
    Set<String>
    getDependentMandatoryParamNames()
    Liefert ein Set mit Parameternamen, die ebenfalls zu Pflichtfeldern werden, wenn aktuelles Feld einen Wert besitzt
    String
    getDescription()
    Beschreibung, welche die Verwendung des Parameters näher erläutert und in der Oberfläche dargestellt werden kann
    default String
    getDisplayName()
    Returns the localized name of this parameter.
    String
    getName()
    The technical name of this parameter, it should not be localized, e.g.
    boolean
    isCrypticValue()
    Legt fest, ob das Feld für die Parameter-Value-Eingabe als Passwortfeld darzustellen ist.
    boolean
    isGroupItem()
    Legt fest, ob der Parameter als Gruppierungüberschrift dient.
    boolean
    isMandatory()
    Legt fest, ob Parameter in Oberfläche als Pflichtfeld dargestellt werden soll
    boolean
    isNameEditable()
    Legt fest, ob Parametername in Oberfläche änderbar sein soll

  • Method Details

    • getName

      String getName()
      The technical name of this parameter, it should not be localized, e.g. myplugin.config.param.1.
      Returns:
      The identifying name of this parameter.

    • getDescription

      String getDescription()
      Beschreibung, welche die Verwendung des Parameters näher erläutert und in der Oberfläche dargestellt werden kann
      Returns:
      eine Zeichenkette oder null

    • isMandatory

      boolean isMandatory()
      Legt fest, ob Parameter in Oberfläche als Pflichtfeld dargestellt werden soll
      Returns:
      true wenn als Pflichtfeld dargestellt, sonst false

    • getDependentMandatoryParamNames

      Set<String> getDependentMandatoryParamNames()
      Liefert ein Set mit Parameternamen, die ebenfalls zu Pflichtfeldern werden, wenn aktuelles Feld einen Wert besitzt
      Returns:
      Set von Parameternamen oder null

    • isNameEditable

      boolean isNameEditable()
      Legt fest, ob Parametername in Oberfläche änderbar sein soll
      Returns:
      true wenn der Parametername in der Oberfläche editierbar sein soll, sonst false

    • isCrypticValue

      boolean isCrypticValue()
      Legt fest, ob das Feld für die Parameter-Value-Eingabe als Passwortfeld darzustellen ist.
      Returns:
      true wenn Feld in der Oberfläche als Passwortfeld dargestellt werden soll, sonst false

    • getDefaultValue

      String getDefaultValue()
      Ermöglicht die Festlegung eines Defaultwertes, der als initialer Parameterwert gesetzt werden soll.
      Returns:
      eine Zeichenkette oder null

    • isGroupItem

      boolean isGroupItem()
      Legt fest, ob der Parameter als Gruppierungüberschrift dient. Dann hat er folgende Eigenschaften:
      • - er ist nicht editierbar
      • - er kann nicht gelöscht werden
      • - er wird nicht validiert
      Returns:
      true wenn es sich bei dem zugrundeliegenden Element um ein Strukturierungselement handelt, sonst false

    • getDisplayName

      default String getDisplayName()
      Returns the localized name of this parameter.
      Returns:
      The name of this parameter that will be shown on the user interface.