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