MaxCulBindingProvider.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.maxcul;

import java.util.HashSet;
import java.util.List;

import org.openhab.binding.maxcul.internal.MaxCulBindingConfig;
import org.openhab.core.binding.BindingProvider;

/**
 * @author Paul Hampson (cyclingengineer)
 * @since 1.6.0
 */
public interface MaxCulBindingProvider extends BindingProvider {

    /**
     * This will return the binding configuration associated with an itemName
     * 
     * @param itemName
     *            Name of item
     * @return Binding configuration for itemName
     */
    MaxCulBindingConfig getConfigForItemName(String itemName);

    /**
     * This will return the first config found for a particular serial number
     * 
     * @param serial
     *            Serial number of device
     * @return First configuration found, null if none are found
     */
    MaxCulBindingConfig getConfigForSerialNumber(String serial);

    /**
     * This will return a collection of configs for a particular serial number
     * 
     * @param serial
     *            Serial number of devices
     * @return All configurations found, null if none are found
     */
    List<MaxCulBindingConfig> getConfigsForSerialNumber(String serial);

    /**
     * This will return a collection of configs for a particular radio address
     * 
     * @param addr
     *            Address of device
     * @return List of configs associated with radio address
     */
    List<MaxCulBindingConfig> getConfigsForRadioAddr(String addr);

    /**
     * Get an item name from a configuration
     * 
     * @param bc
     *            Configuration to look for
     * @return Item Name string
     */
    String getItemNameForConfig(MaxCulBindingConfig bc);

    /**
     * Get an association related to a specific device specified by serial
     * number
     */
    HashSet<MaxCulBindingConfig> getAssociations(String deviceSerial);

    /**
     * Get credit monitor bindings
     */
    List<MaxCulBindingConfig> getCreditMonitorBindings();
}