InsteonHubBindingProvider.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.insteonhub;

import java.util.Set;

import org.openhab.binding.insteonhub.internal.InsteonHubBindingConfig;
import org.openhab.binding.insteonhub.internal.InsteonHubBindingDeviceInfo;
import org.openhab.core.binding.BindingProvider;

/**
 * Insteon Hub BindingProvider interface
 *
 * @author Eric Thill
 * @since 1.4.0
 */
public interface InsteonHubBindingProvider extends BindingProvider {

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

    /**
     * Get all hubId+devices
     * 
     * return Set of devices
     */
    public Set<InsteonHubBindingDeviceInfo> getConfiguredDevices();

    /**
     * Returns the openhab Item Names configured for {@code deviceInfo}
     * 
     * @param deviceInfo
     *            device info (hubId+deviceId)
     *            return Set of Item Names
     */
    public Set<String> getDeviceItemNames(InsteonHubBindingDeviceInfo deviceInfo);

}