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.globalcache.internal.command;
  14
  15 /**
  16  * The {@link CommandInterface} interface class defines the methods that all command classes must implement.
  17  *
  18  * @author Mark Hilbush - Initial contribution
  19  */
  20 public interface CommandInterface {
  21
  22     /**
  23      * Get the module number to which the command will be sent
  24      *
  25      * @return module number as String
  26      */
  27     String getModule();
  28
  29     /**
  30      * Get the connector number to which the command will be sent
  31      *
  32      * @return connector number as String
  33      */
  34     String getConnector();
  35
  36     /**
  37      * Used by command implementations to parse the device's response
  38      */
  39     void parseSuccessfulReply();
  40
  41     /*
  42      * Used by command implementations to report a successful command execution
  43      */
  44     void logSuccess();
  45
  46     /*
  47      * Used by command implementations to report a failed command execution
  48      */
  49     void logFailure();
  50 }