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

   1 /**
   2  * Copyright (c) 2010-2022 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.miele.internal.handler;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.binding.miele.internal.FullyQualifiedApplianceIdentifier;
  17 import org.openhab.binding.miele.internal.api.dto.DeviceClassObject;
  18 import org.openhab.binding.miele.internal.api.dto.DeviceProperty;
  19 import org.openhab.binding.miele.internal.api.dto.HomeDevice;
  20
  21 /**
  22  *
  23  * The {@link ApplianceStatusListener} is notified when an appliance status has changed or
  24  * an appliance has been removed or added.
  25  *
  26  * @author Karel Goderis - Initial contribution
  27  * @author Jacob Laursen - Fixed multicast and protocol support (ZigBee/LAN)
  28  */
  29 @NonNullByDefault
  30 public interface ApplianceStatusListener {
  31
  32     /**
  33      * This method is called whenever the state of the given appliance has changed.
  34      *
  35      * @param applianceIdentifier the fully qualified identifier of the appliance that has changed
  36      * @param dco the POJO containing the new state (properties and/or operations)
  37      */
  38     void onApplianceStateChanged(FullyQualifiedApplianceIdentifier applianceIdentifier, DeviceClassObject dco);
  39
  40     /**
  41      * This method is called whenever a "property" of the given appliance has changed.
  42      *
  43      * @param applianceIdentifier the fully qualified identifier of the appliance that has changed
  44      * @param dco the POJO containing the new state of the property
  45      */
  46     void onAppliancePropertyChanged(FullyQualifiedApplianceIdentifier applianceIdentifier, DeviceProperty dp);
  47
  48     /**
  49      * This method is called whenever an appliance is removed.
  50      *
  51      * @param appliance The XGW homedevice definition of the appliance that was removed
  52      */
  53     void onApplianceRemoved(HomeDevice appliance);
  54
  55     /**
  56      * This method is called whenever an appliance is added.
  57      *
  58      * @param appliance The XGW homedevice definition of the appliance that was removed
  59      */
  60     void onApplianceAdded(HomeDevice appliance);
  61 }