org.hawaiiframework.exception

Interface ApiError

public interface ApiError

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

Author:

Paul Klos

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Getter for the error code.
String	getReason() Get the error reason.

Method Detail

getErrorCode

String getErrorCode()

Getter for the error code.

Returns:

the error code

getReason

String getReason()

Get the error reason.

Returns:

the reason