git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.homematic.internal.type;
  14
  15 import org.openhab.core.thing.type.ChannelGroupType;
  16 import org.openhab.core.thing.type.ChannelGroupTypeProvider;
  17 import org.openhab.core.thing.type.ChannelGroupTypeUID;
  18
  19 /**
  20  * Extends the ChannelGroupTypeProvider to manually add a ChannelGroupType.
  21  *
  22  * @author Michael Reitler - Initial contribution
  23  */
  24 public interface HomematicChannelGroupTypeProvider extends ChannelGroupTypeProvider {
  25
  26     /**
  27      * Adds the ChannelGroupType to this provider.
  28      */
  29     void addChannelGroupType(ChannelGroupType channelGroupType);
  30
  31     /**
  32      * Use this method to lookup a ChannelGroupType which was generated by the
  33      * homematic binding. Other than {@link #getChannelGroupType(ChannelGroupTypeUID, Locale)}
  34      * of this provider, it will return also those {@link ChannelGroupType}s
  35      * which are excluded by {@link HomematicThingTypeExcluder}
  36      *
  37      * @param channelGroupTypeUID
  38      *            e.g. <i>homematic:HM-WDS40-TH-I-2_0</i>
  39      * @return ChannelGroupType that was added to HomematicChannelGroupTypeProvider, identified
  40      *         by its config-description-uri<br>
  41      *         <i>null</i> if no ChannelGroupType with the given UID was added
  42      *         before
  43      */
  44     ChannelGroupType getInternalChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID);
  45 }