org.bidib.wizard.common.model.settings.IntegrationSettingsInterface Maven / Gradle / Ivy

Go to download
package org.bidib.wizard.common.model.settings;

import org.bidib.wizard.api.model.bean.ObservableBean;

public interface IntegrationSettingsInterface extends ObservableBean, SettingsInterface {

    static final String PROPERTY_LISTEN_PORT_Z21 = "listenPortZ21";

    static final String PROPERTY_BIND_ADDRESS_Z21 = "bindAddressZ21";

    static final String PROPERTY_Z21_RECEIVER_ENABLED = "z21ReceiverEnabled";

    static final String PROPERTY_USE_RF_BASIS = "useRfBasis";

    static final String PROPERTY_PREVENT_LOG_GETSTATUS_MESSAGE = "preventLogGetStatusMessage";

    static final String PROPERTY_USE_COMMANDSTATION_NODE_NAME = "useCommandStationNodeName";

    static final String PROPERTY_COMMANDSTATION_NODE_NAME = "commandStationNodeName";

    static final String BIND_ADDRESS_ALL_INTERFACES = "0.0.0.0";

    /**
     * Set the the listen port for the Z21 receiver. Default is 21105.
     * 
     * @param listenPortZ21
     *            the listen port for the Z21 receiver
     */
    void setListenPortZ21(int listenPortZ21);

    /**
     * @return the listen port for the Z21 receiver
     */
    int getListenPortZ21();

    /**
     * Set the bind address for the Z21 receiver.
     * 
     * @param bindAddressZ21
     *            the bind address, use {@code 0.0.0.0} to listen on all interfaces
     */
    void setBindAddressZ21(String bindAddressZ21);

    /**
     * @return the bind address for the Z21 recevier
     */
    String getBindAddressZ21();

    /**
     * Set the Z21 receiver enabled.
     * 
     * @param z21ReceiverEnabled
     *            {@code true}: start Z21 receiver, {@code false}: do not start Z21 receiver
     */
    void setZ21ReceiverEnabled(boolean z21ReceiverEnabled);

    /**
     * @return the Z21 receiver enabled flag
     */
    boolean isZ21ReceiverEnabled();

    /**
     * Set the use the RF-Basis flag. If {@code true} the RF-Basis is used instead of command station.
     * 
     * @param useRfBasis
     *            use the RF-Basis
     */
    void setUseRfBasis(boolean useRfBasis);

    /**
     * @return use the RF-basis
     */
    boolean isUseRfBasis();

    /**
     * Set the prevent log get status messages. The get status message is sent every second and will polute the log.
     * 
     * @param preventLogGetStatusMessage
     *            {@code true}: prevent log get status messages, {@code false}: log get status messages
     */
    void setPreventLogGetStatusMessage(boolean preventLogGetStatusMessage);

    /**
     * @return the prevent log get status messages flag
     */
    boolean isPreventLogGetStatusMessage();

    /**
     * @return the useCommandStationNodeName
     */
    boolean isUseCommandStationNodeName();

    /**
     * @param useCommandStationNodeName
     *            the useCommandStationNodeName to set
     */
    void setUseCommandStationNodeName(boolean useCommandStationNodeName);

    /**
     * @return the commandStationNodeName
     */
    String getCommandStationNodeName();

    /**
     * @param commandStationNodeName
     *            the commandStationNodeName to set
     */
    void setCommandStationNodeName(String commandStationNodeName);
}