org.bidib.wizard.api.service.node.BoosterService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bidibwizard-api Show documentation
jBiDiB BiDiB Wizard API POM
There is a newer version: 2.0.29
package org.bidib.wizard.api.service.node;

import java.util.List;

import org.bidib.api.json.types.NodeAddress;
import org.bidib.wizard.api.model.BoosterNodeInterface;
import org.bidib.wizard.api.model.CommandStationNodeInterface;
import org.bidib.wizard.api.model.InterfaceNodeInterface;
import org.bidib.wizard.model.status.BoosterStatus;
import org.bidib.wizard.model.status.CommandStationStatus;

public interface BoosterService {

    /**
     * Set the booster state.
     * 
     * @param connectionId
     *            the connection id
     * @param nodeAddress
     *            the node address
     * @param boosterState
     *            the requested booster state
     */
    void setBoosterState(String connectionId, NodeAddress nodeAddress, BoosterStatus boosterState);

    /**
     * Set the booster state.
     * 
     * @param connectionId
     *            the connection id
     * @param node
     *            the node
     * @param boosterState
     *            the requested booster state
     */
    void setBoosterState(String connectionId, BoosterNodeInterface node, BoosterStatus boosterState);

    /**
     * Set the booster state.
     * 
     * @param connectionId
     *            the connection id
     * @param node
     *            the node
     * @param boosterState
     *            the requested booster state
     */
    void setBoosterState(String connectionId, InterfaceNodeInterface node, BoosterStatus boosterState);

    /**
     * Query the state of the booster.
     * 
     * @param connectionId
     *            the connection id
     * @param nodeAddress
     *            the node address
     */
    void queryBoosterState(String connectionId, NodeAddress nodeAddress);

    /**
     * Query the state of the booster.
     * 
     * @param connectionId
     *            the connection id
     * @param node
     *            the node
     */
    void queryBoosterState(String connectionId, BoosterNodeInterface node);

    /**
     * Get the booster nodes.
     * 
     * @param connectionId
     *            the connection id
     * @return the list of booster nodes
     */
    List getBoosterNodes(String connectionId);

    /**
     * Set the command station status.
     * 
     * @param connectionId
     *            the connection id
     * @param commandStationNode
     *            the node
     * @param requestedStatus
     *            the requested status
     */
    void setCommandStationState(
        String connectionId, CommandStationNodeInterface commandStationNode, CommandStationStatus requestedStatus);

}