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 package org.kuali.rice.kew.mail;
17
18 import org.kuali.rice.kew.api.action.ActionRequest;
19 import org.kuali.rice.kew.api.document.Document;
20
21 /**
22 * Application areas can implement this interface to generate custom email content.
23 *
24 * At the point that getCustomEmailSubject() and getCustomEmailBody() are called, the
25 * RouteHeaderVO and ActionRequestVO have already been set so the implementing class can
26 * simply call the approriate getters to retrieve the data beans.
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 */
30 public interface CustomEmailAttribute {
31
32 /**
33 * Returns a String that will be appended to the standard email subject.
34 */
35 public String getCustomEmailSubject() throws Exception;
36
37 /**
38 * Returns a String that will be appeneded to the standard email body.
39 */
40 public String getCustomEmailBody() throws Exception;
41
42 /**
43 * Gets the RouteHeaderVO bean which has document data
44 * @return
45 */
46 public Document getRouteHeaderVO();
47 public void setRouteHeaderVO(Document routeHeaderVO);
48 public ActionRequest getActionRequestVO();
49 public void setActionRequestVO(ActionRequest actionRequestVO);
50
51 }