org.kuali.rice.krad.service
Interface KualiExceptionIncidentService

All Superinterfaces:
KualiFeedbackService
All Known Implementing Classes:
KualiExceptionIncidentServiceImpl

public interface KualiExceptionIncidentService
extends KualiFeedbackService

This is used for sending report of an incident

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

Field Summary
 
Fields inherited from interface org.kuali.rice.krad.service.KualiFeedbackService
REPORT_MAIL_LIST
 
Method Summary
 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.
 
Methods inherited from interface org.kuali.rice.krad.service.KualiFeedbackService
emailReport, sendFeedback
 

Method Detail

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:


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.