Package de.xima.fc.plugin.models.config

Class AConfigParam

java.lang.Object
de.xima.fc.plugin.models.config.AConfigParam
All Implemented Interfaces:
IBasicConfigParam, Serializable
Direct Known Subclasses:
BundleConfigGroupItem, BundleConfigParam, PluginConfigGroupItem, PluginConfigParam
public abstract class AConfigParam extends Object implements IBasicConfigParam, Serializable
Referenz Implementierung für die IPluginConfigParam - Schnittstelle
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

    • name

      protected String name

    • description

      protected String description

    • mandatory

      protected boolean mandatory

    • nameEditable

      protected boolean nameEditable

    • crypticValue

      protected boolean crypticValue

    • defaultValue

      protected String defaultValue

    • dependentMandatoryParamNames

      protected Set<String> dependentMandatoryParamNames

  • Constructor Details

    • AConfigParam

      public AConfigParam(String name)

    • AConfigParam

      public AConfigParam(String name, boolean mandatory)

    • AConfigParam

      public AConfigParam(String name, String description, boolean mandatory)

  • Method Details

    • getName

      public String getName()
      Description copied from interface: IBasicConfigParam
      The technical name of this parameter, it should not be localized, e.g. myplugin.config.param.1.
      Specified by:
      getName in interface IBasicConfigParam
      Returns:
      The identifying name of this parameter.

    • setName

      public void setName(String name)

    • getDescription

      public String getDescription()
      Description copied from interface: IBasicConfigParam
      Beschreibung, welche die Verwendung des Parameters näher erläutert und in der Oberfläche dargestellt werden kann
      Specified by:
      getDescription in interface IBasicConfigParam
      Returns:
      eine Zeichenkette oder null

    • setDescription

      public void setDescription(String description)

    • isMandatory

      public boolean isMandatory()
      Description copied from interface: IBasicConfigParam
      Legt fest, ob Parameter in Oberfläche als Pflichtfeld dargestellt werden soll
      Specified by:
      isMandatory in interface IBasicConfigParam
      Returns:
      true wenn als Pflichtfeld dargestellt, sonst false

    • setMandatory

      public void setMandatory(boolean mandatory)

    • isNameEditable

      public boolean isNameEditable()
      Description copied from interface: IBasicConfigParam
      Legt fest, ob Parametername in Oberfläche änderbar sein soll
      Specified by:
      isNameEditable in interface IBasicConfigParam
      Returns:
      true wenn der Parametername in der Oberfläche editierbar sein soll, sonst false

    • isCrypticValue

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

    • setNameEditable

      public void setNameEditable(boolean nameEditable)

    • setCrypticValue

      public void setCrypticValue(boolean crypticValue)

    • getDefaultValue

      public String getDefaultValue()
      Description copied from interface: IBasicConfigParam
      Ermöglicht die Festlegung eines Defaultwertes, der als initialer Parameterwert gesetzt werden soll.
      Specified by:
      getDefaultValue in interface IBasicConfigParam
      Returns:
      eine Zeichenkette oder null

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • getDependentMandatoryParamNames

      public Set<String> getDependentMandatoryParamNames()
      Description copied from interface: IBasicConfigParam
      Liefert ein Set mit Parameternamen, die ebenfalls zu Pflichtfeldern werden, wenn aktuelles Feld einen Wert besitzt
      Specified by:
      getDependentMandatoryParamNames in interface IBasicConfigParam
      Returns:
      Set von Parameternamen oder null

    • setDependentMandatoryParamNames

      public void setDependentMandatoryParamNames(String[] dependentMandatoryParamNames)

    • addDependentMandatoryParamName

      public void addDependentMandatoryParamName(String dependentMandatoryParamName)

    • isGroupItem

      public boolean isGroupItem()
      Description copied from interface: IBasicConfigParam
      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
      Specified by:
      isGroupItem in interface IBasicConfigParam
      Returns:
      true wenn es sich bei dem zugrundeliegenden Element um ein Strukturierungselement handelt, sonst false

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object