001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.mail;
017
018import org.kuali.rice.kew.api.action.ActionRequest;
019import org.kuali.rice.kew.api.document.Document;
020
021/**
022 * Application areas can implement this interface to generate custom email content.
023 * 
024 * At the point that getCustomEmailSubject() and getCustomEmailBody() are called, the
025 * RouteHeaderVO and ActionRequestVO have already been set so the implementing class can
026 * simply call the approriate getters to retrieve the data beans.
027 * 
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030public interface CustomEmailAttribute {
031
032        /**
033         * Returns a String that will be appended to the standard email subject.
034         */
035    public String getCustomEmailSubject() throws Exception;
036    
037    /**
038     * Returns a String that will be appeneded to the standard email body.
039     */
040    public String getCustomEmailBody() throws Exception;
041    
042    /**
043     * Gets the RouteHeaderVO bean which has document data 
044     * @return
045     */
046    public Document getRouteHeaderVO();
047    public void setRouteHeaderVO(Document routeHeaderVO);
048    public ActionRequest getActionRequestVO();
049    public void setActionRequestVO(ActionRequest actionRequestVO);
050    
051}