org.kuali.rice.kns.service
Interface KualiExceptionIncidentService

All Known Implementing Classes:

KualiExceptionIncidentServiceImpl

public interface KualiExceptionIncidentService

This is used for sending report of an incident

Author:

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

Method Summary

void	emailReport(String subject, String message) This method send email to the defined mailing list with a specified subject and message.
KualiExceptionIncident	getExceptionIncident(Exception exception, Map<String,String> properties) This method create an instance of the KualiExceptionIncident from its factory.
KualiExceptionIncident	getExceptionIncident(Map<String,String> properties) This method create an instance of the KualiExceptionIncident from its factory.
void	report(KualiExceptionIncident exceptionIncident) This method send email to the defined mailing list using the exception incident instance.

Method Detail

emailReport

void emailReport(String subject,
                 String message)
                 throws Exception

This method send email to the defined mailing list with a specified subject and message.

Parameters:

subject -

message -

Throws:

Exception

report

void report(KualiExceptionIncident exceptionIncident)
            throws Exception

This method send email to the defined mailing list using the exception incident instance.

Parameters:

exceptionIncident -

Throws:

Exception

getExceptionIncident

KualiExceptionIncident getExceptionIncident(Exception exception,
                                            Map<String,String> properties)

This method create an instance of the KualiExceptionIncident from its factory.

Parameters:

exception -

properties - Additional information when the exception is thrown

example:

• Document id
• User email
• User name
• Component name

Returns:

getExceptionIncident

KualiExceptionIncident getExceptionIncident(Map<String,String> properties)

This method create an instance of the KualiExceptionIncident from its factory. This method is used when the thrown exception is not available. It's an implicit initialization.

Parameters:

properties - The list of name-value pairs containing the thrown exception information

Returns: