1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.kuali.rice.krad.service;
18
19 /**
20 * This new feedback service was added to refactor
21 * KualiExceptionIncidentService. Now the KualiExceptionIncidentService
22 * extends this service so that exception reporting is considered to be a type
23 * of feedback. Both services share the emailReport method which formats and
24 * sends an email to the appropriate list.
25 */
26 public interface KualiFeedbackService {
27
28 /**
29 * This property must be defined in the base configuration file for specifying
30 * the mailing list for the report to be sent.
31 * <p>Example:
32 * <code>
33 * <param name="KualiFeedbackService.REPORT_MAIL_LIST">a@y,b@z</param>
34 * </code>
35 */
36 public static final String REPORT_MAIL_LIST = String.format("%s.REPORT_MAIL_LIST", KualiFeedbackService.class.getSimpleName());
37
38 /**
39 * This method send email to the defined mailing list with a specified subject and
40 * message.
41 *
42 * @param subject
43 * @param message
44 * @throws Exception
45 */
46 public void emailReport(String subject, String message) throws Exception;
47
48 public void sendFeedback(String documentId, String componentName, String description) throws Exception;
49 }