01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.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 edu.iu.uis.eden.plugin.attributes;
18:
19: import edu.iu.uis.eden.clientapp.vo.ActionRequestVO;
20: import edu.iu.uis.eden.clientapp.vo.RouteHeaderVO;
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 ewestfal
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 RouteHeaderVO getRouteHeaderVO();
48:
49: public void setRouteHeaderVO(RouteHeaderVO routeHeaderVO);
50:
51: public ActionRequestVO getActionRequestVO();
52:
53: public void setActionRequestVO(ActionRequestVO actionRequestVO);
54:
55: }
|