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.event.types;
  14
  15 import java.util.Map;
  16
  17 import org.openhab.binding.digitalstrom.internal.lib.event.constants.EventResponseEnum;
  18
  19 /**
  20  * The {@link EventItem} represents an event item of a digitalSTROM-Event.
  21  *
  22  * @author Alexander Betker - Initial contribution
  23  * @author Michael Ochel - add getSource()
  24  * @author Matthias Siegele - add getSource()
  25  */
  26 public interface EventItem {
  27
  28     /**
  29      * Returns the name of this {@link EventItem}.
  30      *
  31      * @return name of this {@link EventItem}
  32      */
  33     String getName();
  34
  35     /**
  36      * Returns {@link HashMap} with the properties fiels of this {@link EventItem}.
  37      * The key is an {@link EventResponseEnum} and represents the property name
  38      * and the value is the property value.
  39      *
  40      * @return the properties of this {@link EventItem}
  41      */
  42     Map<EventResponseEnum, String> getProperties();
  43
  44     /**
  45      * Returns {@link HashMap} with the source fields of this {@link EventItem}.
  46      * The key is an {@link EventResponseEnum} and represents the property name
  47      * and the value is the property value.
  48      *
  49      * @return the properties of this {@link EventItem}
  50      */
  51     Map<EventResponseEnum, String> getSource();
  52 }