IError (formcycle: bom 8.2.0 API)

All Superinterfaces:

Serializable
```
public interface IError
extends Serializable
```
Interface for errors that can be returned to the client.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDetail(Locale locale)`	Detailed description of the error.
`String`	`getErrorCode()`	Unique identifier of the error.
`String`	`getPrivateDetail()`	Private detail of the error.
`int`	`getStatusCode()`	HTTP status code of the error.
`String`	`getTitle(Locale locale)`	Title of the error.

- Method Detail
  - getErrorCode
```
String getErrorCode()
```
    Unique identifier of the error.
    
    Returns:
    
    Unique identifier of the error.
  - getStatusCode
```
int getStatusCode()
```
    HTTP status code of the error.
    
    Returns:
    
    HTTP status code of the error.
  - getPrivateDetail
```
String getPrivateDetail()
```
    Private detail of the error. This detail is not meant to be shown to the user. It is meant for debugging purposes only and should be in english.
    
    Returns:
    
    Private detail of the error.
  - getTitle
```
String getTitle(Locale locale)
```
    Title of the error.
    
    Parameters:
    
    locale - Locale for which the title should be returned.
    
    Returns:
    
    Title of the error for the given locale.
  - getDetail
```
String getDetail(Locale locale)
```
    Detailed description of the error. This description is meant to be shown to the user. Depending on the nature of the error, this may be a detailed explanation of the error or just an error code.
    
    Parameters:
    
    locale - Locale for which the detail should be returned.
    
    Returns:
    
    Detailed description of the error for the given locale.