001    /**
002     * Copyright 2005-2013 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     */
016    package org.kuali.rice.kew.mail.service;
017    
018    import java.util.Collection;
019    
020    import org.kuali.rice.core.api.mail.EmailContent;
021    import org.kuali.rice.kew.api.action.ActionItem;
022    import org.kuali.rice.kew.doctype.bo.DocumentType;
023    import org.kuali.rice.kew.feedback.web.FeedbackForm;
024    import org.kuali.rice.kim.api.identity.Person;
025    
026    /**
027     * Interface for generating email message content for various types of messages the system needs to send
028     * @author Kuali Rice Team (rice.collab@kuali.org)
029     * @see EmailContent
030     */
031    public interface EmailContentService {
032        public EmailContent generateImmediateReminder(Person person, ActionItem actionItem, DocumentType documentType);
033        public EmailContent generateDailyReminder(Person person, Collection<ActionItem> actionItems);
034        public EmailContent generateWeeklyReminder(Person person, Collection<ActionItem> actionItems);
035        public EmailContent generateFeedback(FeedbackForm form);
036    
037        /* these are more or less helper utilities and probably should live in some core helper class */
038        public String getDocumentTypeEmailAddress(DocumentType documentType);
039        public String getApplicationEmailAddress();
040    }