1 /*
2 * Copyright 2005-2008 The Kuali Foundation
3 *
4 *
5 * Licensed under the Educational Community License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.opensource.org/licenses/ecl2.php
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.kuali.rice.kew.mail;
18
19 import org.kuali.rice.kew.dto.ActionRequestDTO;
20 import org.kuali.rice.kew.dto.RouteHeaderDTO;
21
22 /**
23 * Application areas can implement this interface to generate custom email content.
24 *
25 * At the point that getCustomEmailSubject() and getCustomEmailBody() are called, the
26 * RouteHeaderVO and ActionRequestVO have already been set so the implementing class can
27 * simply call the approriate getters to retrieve the data beans.
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 */
31 public interface CustomEmailAttribute {
32
33 /**
34 * Returns a String that will be appended to the standard email subject.
35 */
36 public String getCustomEmailSubject() throws Exception;
37
38 /**
39 * Returns a String that will be appeneded to the standard email body.
40 */
41 public String getCustomEmailBody() throws Exception;
42
43 /**
44 * Gets the RouteHeaderVO bean which has document data
45 * @return
46 */
47 public RouteHeaderDTO getRouteHeaderVO();
48 public void setRouteHeaderVO(RouteHeaderDTO routeHeaderVO);
49 public ActionRequestDTO getActionRequestVO();
50 public void setActionRequestVO(ActionRequestDTO actionRequestVO);
51
52 }