Package de.xima.fc.plugin.config

Interface IParameterModel

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    ParameterModel
    public interface IParameterModel
extends Serializable
    Interface für den Zugriff auf wesentliche Eigenschaften, sowie den Wert eines Parameter-Objektes
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • getParamName

        String getParamName()
        Liefert den Namen des Parameter zurück.
        Returns:
        den Parameternamen

      • setParamName

        void setParamName​(String name)
        Setzt den Namen des Parameters.
        Parameters:
        name - den Parameternamen

      • getParamValue

        String getParamValue()
        Liefert den Wert des Parameters zurück.
        Returns:
        den Wert des Parameter oder null

      • setParamValue

        void setParamValue​(String value)
        Setzt den Wert eines Parameter.
        Parameters:
        value - the value to set

      • getParamDescription

        String getParamDescription()
        Liefert die bei der Parameterdefinition hinterlegte Beschreibung
        Returns:
        eien erläuternde Beschreibung zum Parameter oder null

      • isParamMandatory

        boolean isParamMandatory()
        Liefert die Aussage, ob es sich um einen Pflichtparamter handelt
        Returns:
        true wenn es sich um eine Pflichtparameter handelt, sonst false

      • setParamMandatory

        void setParamMandatory​(boolean paramMandatory)
        Ermöglicht das Setzen des Parameters als Pflichtparameter.
        Parameters:
        paramMandatory - true wenn der Parameter zu einem Pflichtparameter werden soll, sonst false

      • isDeletable

        boolean isDeletable()
        Liefert die Aussage, ob der Parameter bei Anzeige in der Oberfläche gelöscht werden darf.
        Returns:
        true wenn ein Löschen möglich ist, false wenn nicht

      • getParamDisplayName

        default String getParamDisplayName()
        Returns:
        The name that should be displayed on the UI.

      • setParamDisplayName

        default void setParamDisplayName​(String displayName)
        Parameters:
        displayName - The name that should be displayed on the UI.