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.digitalstrom.internal.lib.structure.devices.deviceparameters;
  14
  15 import org.openhab.binding.digitalstrom.internal.lib.structure.scene.constants.Scene;
  16
  17 /**
  18  * The {@link DeviceSceneSpec} saves a digitalSTROM-Device scene mode.
  19  *
  20  * @author Alexander Betker - Initial contribution
  21  * @author Michael Ochel - add missing java-doc
  22  * @author Matthias Siegele - add missing java-doc
  23  */
  24 public interface DeviceSceneSpec {
  25
  26     /**
  27      * Returns the sceneID.
  28      *
  29      * @return sceneID
  30      */
  31     Scene getScene();
  32
  33     /**
  34      * Returns true, if the don't care flag is set, otherwise false.
  35      *
  36      * @return true, if dont't care is set, otherwise false
  37      */
  38     boolean isDontCare();
  39
  40     /**
  41      * Sets the don't care flag.
  42      *
  43      * @param dontcare to set
  44      */
  45     void setDontcare(boolean dontcare);
  46
  47     /**
  48      * Returns true, if the local priority flag is set, otherwise false.
  49      *
  50      * @return true, if local priority is, set otherwise false
  51      */
  52     boolean isLocalPrio();
  53
  54     /**
  55      * Sets the local priority flag.
  56      *
  57      * @param localPrio to set
  58      */
  59     void setLocalPrio(boolean localPrio);
  60
  61     /**
  62      * Returns true, if the special mode flag is set, otherwise false.
  63      *
  64      * @return true, if special mode is set, otherwise false
  65      */
  66     boolean isSpecialMode();
  67
  68     /**
  69      * Sets the special mode flag.
  70      *
  71      * @param specialMode to set
  72      */
  73     void setSpecialMode(boolean specialMode);
  74
  75     /**
  76      * Returns true, if the flash mode flag is set, otherwise false.
  77      *
  78      * @return true, if flash mode is set, otherwise false
  79      */
  80     boolean isFlashMode();
  81
  82     /**
  83      * Sets the flash mode flag.
  84      *
  85      * @param flashMode to set
  86      */
  87     void setFlashMode(boolean flashMode);
  88 }