org.bidib.wizard.common.script.booster.BoosterScripting Maven / Gradle / Ivy

Go to download
package org.bidib.wizard.common.script.booster;

import org.bidib.wizard.api.model.BoosterNodeInterface;
import org.bidib.wizard.api.model.CommandStationNodeInterface;
import org.bidib.wizard.api.model.NodeInterface;
import org.bidib.wizard.api.script.Scripting;
import org.bidib.wizard.model.status.BoosterStatus;
import org.bidib.wizard.model.status.CommandStationStatus;

public interface BoosterScripting extends Scripting {

    /**
     * Get the node by the uniqueId.
     * 
     * @param uniqueId
     *            the uniqueId of the node
     * @return the node
     */
    NodeInterface getNodeByUniqueIdWithoutClassBits(byte[] uniqueId);

    /**
     * Set the booster status.
     * 
     * @param boosterNode
     *            the node
     * @param requestedStatus
     *            the requested status
     */
    void setBoosterStatus(final BoosterNodeInterface boosterNode, final BoosterStatus requestedStatus);

    /**
     * Set the command station status.
     * 
     * @param commandStationNode
     *            the node
     * @param requestedStatus
     *            the requested status
     */
    void setCommandStationStatus(CommandStationNodeInterface commandStationNode, CommandStationStatus requestedStatus);

    /**
     * Query the command station status.
     * 
     * @param commandStationNode
     *            the node
     * @return the current status
     */
    CommandStationStatus queryCommandStationStatus(final CommandStationNodeInterface commandStationNode);
}