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