RFXComBindingProvider.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.rfxcom;

import org.openhab.binding.rfxcom.internal.messages.RFXComBaseMessage.PacketType;
import org.openhab.core.autoupdate.AutoUpdateBindingProvider;

/**
 * This interface is implemented by classes that can provide mapping information
 * between openHAB items and RFXCOM items.
 *
 * Implementing classes should register themselves as a service in order to be
 * taken into account.
 *
 * Extending AutoUpdateBindingProvider to only update the state of items if
 * the command was successfully sent by the RFXComm Tranceiver hardware.
 *
 * @author Pauli Anttila, Jürgen Richtsfeld
 * @since 1.2.0
 */
public interface RFXComBindingProvider extends AutoUpdateBindingProvider {

    /**
     * Returns the id to the given <code>itemName</code>.
     * 
     * @param itemName
     *            the item for which to find a id.
     * 
     * @return the corresponding id to the given <code>itemName</code>.
     */
    public String getId(String itemName);

    /**
     * Returns the value selector to the given <code>itemName</code>.
     * 
     * @param itemName
     *            the item for which to find a unit code.
     * 
     * @return the corresponding value selector to the given
     *         <code>itemName</code>.
     */
    public RFXComValueSelector getValueSelector(String itemName);

    /**
     * Returns item direction to the given <code>itemName</code>.
     * 
     * @param itemName
     *            the item for which to find a binding mode.
     * 
     * @return true if item is in binding.
     */
    public boolean isInBinding(String itemName);

    /**
     * Returns item packet type to the given <code>itemName</code>.
     * 
     * @param itemName
     *            the item for which to find a packet type.
     * 
     * @return the corresponding packet type to the given <code>itemName</code>.
     */
    public PacketType getPacketType(String itemName);

    /**
     * Returns item sub type to the given <code>itemName</code>.
     * 
     * @param itemName
     *            the item for which to find a sub type.
     * 
     * @return the corresponding sub type to the given <code>itemName</code>.
     */
    public Object getSubType(String itemName);

}