Enum Class EUACode

java.lang.Object
java.lang.Enum<EUACode>
fr.inria.rules.integraal.api.external.eua.EUACode
All Implemented Interfaces:
Serializable, Comparable<EUACode>, Constable
public enum EUACode extends Enum<EUACode>
Represents standardized result codes used in EUA responses.

Each EUACode corresponds to a specific application-level outcome, such as success, known error conditions (e.g., object already exists), or structural/environmental constraints. These codes are primarily intended to be consumed by end-user interfaces, APIs, or external tools interfacing with Integraal.

The convention is:

  • Positive codes → success
  • Negative codes → known failures or invalid operations
This enum is designed to provide semantic meaning to status codes in a consistent and extensible way.

  • Enum Constant Details

    • SUCCESS

      public static final EUACode SUCCESS
      No error, everything went fine.

    • UNKNOWN_OBJECT

      public static final EUACode UNKNOWN_OBJECT
      The name of the object to be retrieved in the environment doesn't identify an object of the environment (it doesn't exist in the environment).

    • EXISTING_OBJECT

      public static final EUACode EXISTING_OBJECT
      The name of the object to be added to the environment already exists.

    • FULL_ENVIRONMENT

      public static final EUACode FULL_ENVIRONMENT
      The environment is full, nothing can be added.

    • FORMAT_ERROR

      public static final EUACode FORMAT_ERROR
      The provided string is not in correct dlgp or vd format.

    • UNSUITABLE_ELEMENT

      public static final EUACode UNSUITABLE_ELEMENT
      The string to be inserted in an object contains dlgp (or vd) entries that doesn't comply with the object type/nature (i.e. trying to add rules to a fact base).

    • FORBIDDEN_DELETION

      public static final EUACode FORBIDDEN_DELETION
      The target of deletion is part of a complex object (and it is forbidden).

    • NO_NEXT_ELEMENT

      public static final EUACode NO_NEXT_ELEMENT
      The iterator has no next element (last element has been reached).

    • UNKNOWN_PARAMETER

      public static final EUACode UNKNOWN_PARAMETER
      A command is called with an unknown parameter.

    • UNIDENTIFIED_ERROR

      public static final EUACode UNIDENTIFIED_ERROR
      Unidentified error.

  • Method Details

    • values

      public static EUACode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static EUACode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public int getCode()
      Returns the EUACode as an integer.
      Returns:
      an integer.