Caplin Systems - ErrorEvent (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.trading.ResponderEvent<T>
- - com.caplin.motif.fx.trading.ErrorEvent<T>

Type Parameters:

T - Extends UserTrade which contains the capabilities to obtain fields from the trade message and send trade messages.
```
public class ErrorEvent<T extends UserTrade>
extends ResponderEvent<T>
```
An event that is sent once an error has occurred; which the frontend should be notified about.

Note that error codes are entirely up to the backend, but should allow traders to notify support people of the exact issue. This may come directly from the trading system.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ERROR`	The event name for an Error event
`static String`	`ERROR_CODE`	The Error Code field
`static String`	`ERROR_MESSAGE`	The Error Message field

Fields inherited from class com.caplin.motif.fx.trading.ResponderEvent
fields

Constructor Summary

Constructors
Constructor Description

ErrorEvent(String errorMessage, String errorCode)
Constructs an error event for the specified message and code.

Method Summary
- Methods inherited from class com.caplin.motif.fx.trading.ResponderEvent
  addField, addFields, equals, getEventName, getField, getFields, hashCode, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ERROR
```
public static final String ERROR
```
    The event name for an Error event
    
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
public static final String ERROR_CODE
```
    The Error Code field
    
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE
```
public static final String ERROR_MESSAGE
```
    The Error Message field
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ErrorEvent
```
public ErrorEvent(String errorMessage,
                  String errorCode)
```
    Constructs an error event for the specified message and code.
    
    Parameters:
    
    errorMessage - The error message that will be displayed to the frontend user.
    
    errorCode - The error code that will be displayed to the frontend user.