1 /**
2 * Copyright 2005-2013 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 package org.kuali.rice.krad.service;
17
18 /**
19 * This new feedback service was added to refactor
20 * KualiExceptionIncidentService. Now the KualiExceptionIncidentService
21 * extends this service so that exception reporting is considered to be a type
22 * of feedback. Both services share the emailReport method which formats and
23 * sends an email to the appropriate list.
24 */
25 public interface KualiFeedbackService {
26
27 /**
28 * This property must be defined in the base configuration file for specifying
29 * the mailing list for the report to be sent.
30 * <p>Example:
31 * <code>
32 * <param name="KualiFeedbackService.REPORT_MAIL_LIST">a@y,b@z</param>
33 * </code>
34 */
35 public static final String REPORT_MAIL_LIST = String.format("%s.REPORT_MAIL_LIST", KualiFeedbackService.class.getSimpleName());
36
37 /**
38 * This method send email to the defined mailing list with a specified subject and
39 * message.
40 *
41 * @param subject
42 * @param message
43 * @throws Exception
44 */
45 public void emailReport(String subject, String message) throws Exception;
46
47 public void sendFeedback(String documentId, String componentName, String description) throws Exception;
48 }