Interface ApiError

All Superinterfaces:
Serializable

public interface ApiError extends Serializable
Interface that defines an API error of the application. An API error is a well-defined error situation with a unique error code. An application built on Hawaii Framework might implement this using an enum.
Since:
2.0.0
  • Method Summary

    Modifier and Type
    Method
    Description
    Getter for the error code.
    Get the error reason.
  • Method Details

    • getErrorCode

      String getErrorCode()
      Getter for the error code.
      Returns:
      the error code
    • getReason

      String getReason()
      Get the error reason.
      Returns:
      the reason