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.ecobee.internal.dto.thermostat;
  14
  15 /**
  16  * The {@link SecuritySettingsDTO} defines the security settings which a thermostat
  17  * may have. Currently this object stores data specific to access control. If any of
  18  * the XXXAccess fields are not supplied they will default to false. So to set all
  19  * to false where previously some were set to true the caller can either pass all
  20  * the XXXAccess fields explicitly, or pass none and the default will be set for each.
  21  *
  22  * @author Mark Hilbush - Initial contribution
  23  */
  24 public class SecuritySettingsDTO {
  25
  26     /*
  27      * The 4-digit user access code for the thermostat. The code must be set when
  28      * enabling access control. See the callout above for more information.
  29      */
  30     public String userAccessCode;
  31
  32     /*
  33      * The flag for determing whether there are any restrictions on the thermostat
  34      * regarding access control. Default value is false. If all other values are
  35      * true this value will default to true.
  36      */
  37     public Boolean allUserAccess;
  38
  39     /*
  40      * The flag for determing whether there are any restrictions on the thermostat
  41      * regarding access control to the Thermostat Program. Default value is false,
  42      * unless allUserAccess is true.
  43      */
  44     public Boolean programAccess;
  45
  46     /*
  47      * The flag for determing whether there are any restrictions on the thermostat
  48      * regarding access control to the Thermostat system and settings. Default value
  49      * is false, unless allUserAccess is true.
  50      */
  51     public Boolean detailsAccess;
  52
  53     /*
  54      * The flag for determing whether there are any restrictions on the thermostat
  55      * regarding access control to the Thermostat quick save functionality. Default
  56      * value is false, unless allUserAccess is true.
  57      */
  58     public Boolean quickSaveAccess;
  59
  60     /*
  61      * The flag for determing whether there are any restrictions on the thermostat
  62      * regarding access control to the Thermostat vacation functionality. Default
  63      * value is false, unless allUserAccess is true.
  64      */
  65     public Boolean vacationAccess;
  66 }