View Javadoc

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