View Javadoc

1   /**
2    * Copyright 2005-2014 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.service;
17  
18  import java.util.Collection;
19  
20  import org.kuali.rice.core.api.mail.EmailContent;
21  import org.kuali.rice.kew.api.action.ActionItem;
22  import org.kuali.rice.kew.doctype.bo.DocumentType;
23  import org.kuali.rice.kew.feedback.web.FeedbackForm;
24  import org.kuali.rice.kim.api.identity.Person;
25  
26  /**
27   * Interface for generating email message content for various types of messages the system needs to send
28   * @author Kuali Rice Team (rice.collab@kuali.org)
29   * @see EmailContent
30   */
31  public interface EmailContentService {
32      public EmailContent generateImmediateReminder(Person person, ActionItem actionItem, DocumentType documentType);
33      public EmailContent generateDailyReminder(Person person, Collection<ActionItem> actionItems);
34      public EmailContent generateWeeklyReminder(Person person, Collection<ActionItem> actionItems);
35      public EmailContent generateFeedback(FeedbackForm form);
36  
37      /* these are more or less helper utilities and probably should live in some core helper class */
38      public String getDocumentTypeEmailAddress(DocumentType documentType);
39      public String getApplicationEmailAddress();
40  }