KualiExceptionIncident (Rice 2.5.1-SNAPSHOT API)

All Known Implementing Classes:

ExceptionIncident
```
public interface KualiExceptionIncident
```
This class contains the exception incident information, exception, form and session user. It is constructed and saved into the HTTP Request for passing to the jsp when an exception occurs.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_NAME` Form that threw the exception
`static String`	`DESCRIPTION` Additional message from user
`static String`	`DISPLAY_MESSAGE` The error message to be displayed
`static String`	`DOCUMENT_ID` Document id.
`static String`	`EXCEPTION_HIDE_INCIDENT_REPORT` Boolean value for incident report display
`static String`	`EXCEPTION_MESSAGE` The error message
`static String`	`EXCEPTION_REPORT_MESSAGE` The error report message
`static String`	`EXCEPTION_REPORT_SUBJECT` The error report subject built from current settings and caught exception
`static String`	`STACK_TRACE` Detail message not for displaying
`static String`	`USER_EMAIL` Session user email address
`static String`	`USER_NAME` Session user name
`static String`	`UUID` Session user login name

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDisplayMessage(Exception exception)` This method checks the exception (set during construction) and return error message if it's Kuali type of exception (defined by the list of exception names).
`String`	`getProperty(String key)` This method get the specified key value from the implementing class.
`Map<String,String>`	`toProperties()` This method return list of {key,value} pairs that each key is the constants defined in this interface.

- Field Detail
  - EXCEPTION_REPORT_SUBJECT
```
static final String EXCEPTION_REPORT_SUBJECT
```
    The error report subject built from current settings and caught exception
    Value is exceptionReportSubject
    
    See Also:
    Constant Field Values
  - EXCEPTION_HIDE_INCIDENT_REPORT
```
static final String EXCEPTION_HIDE_INCIDENT_REPORT
```
    Boolean value for incident report display
    
    See Also:
    Constant Field Values
  - EXCEPTION_REPORT_MESSAGE
```
static final String EXCEPTION_REPORT_MESSAGE
```
    The error report message
    Value is exceptionReportMessage
    
    See Also:
    Constant Field Values
  - EXCEPTION_MESSAGE
```
static final String EXCEPTION_MESSAGE
```
    The error message
    Value is exceptionMessage
    
    See Also:
    Constant Field Values
  - DISPLAY_MESSAGE
```
static final String DISPLAY_MESSAGE
```
    The error message to be displayed
    Value is displayMessage
    
    See Also:
    Constant Field Values
  - DESCRIPTION
```
static final String DESCRIPTION
```
    Additional message from user
    Value is description
    
    See Also:
    Constant Field Values
  - DOCUMENT_ID
```
static final String DOCUMENT_ID
```
    Document id. it's blank if not a document process
    Value is documentId
    
    See Also:
    Constant Field Values
  - USER_EMAIL
```
static final String USER_EMAIL
```
    Session user email address
    Value is userEmail
    
    See Also:
    Constant Field Values
  - UUID
```
static final String UUID
```
    Session user login name
    Value is principalName
    
    See Also:
    Constant Field Values
  - USER_NAME
```
static final String USER_NAME
```
    Session user name
    Value is userName
    
    See Also:
    Constant Field Values
  - STACK_TRACE
```
static final String STACK_TRACE
```
    Detail message not for displaying
    Value is stackTrace
    
    See Also:
    Constant Field Values
  - COMPONENT_NAME
```
static final String COMPONENT_NAME
```
    Form that threw the exception
    Value is componentName
    
    See Also:
    Constant Field Values
- Method Detail
  - toProperties
```
Map<String,String> toProperties()
```
    This method return list of {key,value} pairs that each key is the constants defined in this interface.
    
    Returns:
    Example: documentId, 2942084 userEmail, someone@somewhere userName, some name componentFormName, Form that threw exception name exceptionMessage, Error message from exception displayMessage, Either exception error message or generic exception error message stackTrace, Exception stack trace here
  - getDisplayMessage
```
String getDisplayMessage(Exception exception)
```
    This method checks the exception (set during construction) and return error message if it's Kuali type of exception (defined by the list of exception names). Otherwise, it returns a generic message.
    
    Parameters:
    exception - The caught exception
    
    Returns:
    display message
  - getProperty
```
String getProperty(String key)
```
    This method get the specified key value from the implementing class.
    
    Parameters:
    key -
    
    Returns:
    null is return if not found

Interface KualiExceptionIncident

Field Summary

Method Summary

Field Detail

EXCEPTION_REPORT_SUBJECT

EXCEPTION_HIDE_INCIDENT_REPORT

EXCEPTION_REPORT_MESSAGE

EXCEPTION_MESSAGE

DISPLAY_MESSAGE

DESCRIPTION

DOCUMENT_ID

USER_EMAIL

UUID

USER_NAME

STACK_TRACE

COMPONENT_NAME

Method Detail

toProperties

getDisplayMessage

getProperty