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.bticinosmarther.internal.api.dto;
  14
  15 /**
  16  * The {@code PlantRef} class defines the dto for Smarther API plant reference object.
  17  *
  18  * @author Fabio Possieri - Initial contribution
  19  */
  20 public class PlantRef {
  21
  22     private String id;
  23     private ModuleRef module;
  24
  25     /**
  26      * Returns the identifier of the plant.
  27      *
  28      * @return a string containing the plant identifier
  29      */
  30     public String getId() {
  31         return id;
  32     }
  33
  34     /**
  35      * Returns the chronothermostat reference inside the plant.
  36      *
  37      * @return a {@link ModuleRef} object representing the chronothermostat module reference
  38      */
  39     public ModuleRef getModule() {
  40         return module;
  41     }
  42
  43     @Override
  44     public String toString() {
  45         return String.format("id=%s, module=[%s]", id, module);
  46     }
  47 }