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.velux.internal.bridge.common;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.binding.velux.internal.things.VeluxProduct;
  17
  18 /**
  19  * <B>Common bridge communication message scheme supported by the </B><I>Velux</I><B> bridge.</B>
  20  * <P>
  21  * Message semantic will be defined by the implementations according to the different comm paths.
  22  * <P>
  23  * In addition to the common methods defined by {@link BridgeCommunicationProtocol}
  24  * each protocol-specific implementation has to provide the following methods:
  25  * <UL>
  26  * <LI>{@link #setProductId} for defining the intended product.
  27  * <LI>{@link #getProduct} for accessing the retrieved information.
  28  * </UL>
  29  *
  30  * @see BridgeCommunicationProtocol
  31  *
  32  * @author Guenther Schreiner - Initial contribution.
  33  */
  34 @NonNullByDefault
  35 public abstract class GetProduct implements BridgeCommunicationProtocol {
  36
  37     /**
  38      * Set the intended node identifier to be queried
  39      *
  40      * @param nodeId Gateway internal node identifier (zero to 199)
  41      */
  42     public abstract void setProductId(int nodeId);
  43
  44     /**
  45      * <B>Retrieval of information about the selected product</B>
  46      *
  47      * @return <b>veluxProduct</b> as VeluxProduct.
  48      */
  49     public abstract VeluxProduct getProduct();
  50 }