de.bund.bva.isyfact.konfiguration.common.Benutzerkonfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isy-konfiguration Show documentation
Stellt eine Komponente für die Konfiguration von Anwendungen bereit.
The newest version!
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * The Federal Office of Administration (Bundesverwaltungsamt, BVA)
 * licenses this file to you under the Apache License, Version 2.0 (the
 * License). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package de.bund.bva.isyfact.konfiguration.common;

/**
 * Bietet Zugriff auf die Benutzerkonfiguration des aktuellen Benutzers.
 * 
 * The module isy-konfiguration is deprecated and will be removed in a future release.
 * Please use the built-in mechanism of the springframework instead.
 * 
 * https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config
 *
 * @deprecated since IsyFact 3.1.0
 */
@Deprecated
public interface Benutzerkonfiguration extends Konfiguration {

    /**
     * Setzt einen String-Wert in der Konfiguration des aktuellen Benutzers.
     * 
     * @param schluessel
     *            der Name des Konfigurationsparameters
     * @param wert
     *            der zu setzende Wert
     */
    public void setValue(String schluessel, String wert);

    /**
     * Setzt einen Integer-Wert in der Konfiguration des aktuellen Benutzers.
     * 
     * @param schluessel
     *            der Name des Konfigurationsparameters
     * @param wert
     *            der zu setzende Wert
     */
    public void setValue(String schluessel, int wert);

    /**
     * Setzt einen Long-Wert in der Konfiguration des aktuellen Benutzers.
     * 
     * @param schluessel
     *            der Name des Konfigurationsparameters
     * @param wert
     *            der zu setzende Wert
     */
    public void setValue(String schluessel, long wert);

    /**
     * Setzt einen Double-Wert in der Konfiguration des aktuellen Benutzers.
     * 
     * @param schluessel
     *            der Name des Konfigurationsparameters
     * @param wert
     *            der zu setzende Wert
     */
    public void setValue(String schluessel, double wert);

    /**
     * Setzt einen Boolean-Wert in der Konfiguration des aktuellen Benutzers.
     * 
     * @param schluessel
     *            der Name des Konfigurationsparameters
     * @param wert
     *            der zu setzende Wert
     */
    public void setValue(String schluessel, boolean wert);

    /**
     * Entfernt den gegebenen Konfigurationsschlüssel aus der Konfiguration des aktuellen Benutzers.
     * 
     * @param schluessel
     *            der Name des Konfigurationsparameters
     * @return {@code true}, wenn der Konfigurationsschlüssel entfernt wurde, {@code false} wenn er nicht
     *         vorhanden war.
     */
    public boolean removeValue(String schluessel);
}