Enum ResultCode

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable

    
    public enum ResultCode
    extends Enum<ResultCode>
                        

    Status code supplied by the home power plant for certain write operations.

    Since:

    2.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class ResultCode.Companion
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      SUCCESS

      Operation successful; rscpCode = 0

      UNHANDLED

      Unknown: Value ignored by home power plant???; rscpCode = 1

      ACCESS_DENIED

      Missing permission to change the value; rscpCode = 2

      FORMAT_ERROR

      The request value is invalid; rscpCode = 3

      AGAIN

      Unknown: Try again later??; rscpCode = 4

      UNKNOWN

      For all other codes; rscpCode = -1

    • Method Summary

      Modifier and Type Method Description
      final ResultCode valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<ResultCode> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final Integer getRscpCode()
      final EnumEntries<ResultCode> getEntries() Status code supplied by the home power plant for certain write operations.
      • Methods inherited from class kotlin.Enum

        getName, getOrdinal
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • valueOf

         final ResultCode valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

        Parameters:
        value - Code defined by E3DC
      • values

         final Array<ResultCode> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.