YamahaReceiverBindingProvider.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.yamahareceiver;

import java.util.Map;

import org.openhab.binding.yamahareceiver.internal.YamahaReceiverBindingConfig;
import org.openhab.core.binding.BindingProvider;

/**
 * Yamaha Receiver BindingProvider interface
 *
 * @author Eric Thill
 * @since 1.6.0
 */
public interface YamahaReceiverBindingProvider extends BindingProvider {

    /**
     * Returns the Item Configuration identified by {@code itemName}.
     * 
     * @param itemName
     *            the name of the Item.
     * @return The Item Configuration identified by {@code itemName}.
     * 
     */
    public YamahaReceiverBindingConfig getItemConfig(String itemName);

    /**
     * Gets all of the configurations registered to a particular device
     * identified by {@code deviceUid}
     * 
     * @param deviceUid
     *            the uid of the device
     * @param items
     *            the map of configurations to populate. key=itemName,
     *            value=configuration
     */
    public void getDeviceConfigs(String deviceUid, Map<String, YamahaReceiverBindingConfig> configs);

}