01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/email/tags/sakai_2-4-1/email-api/api/src/java/org/sakaiproject/email/api/DigestEdit.java $
03: * $Id: DigestEdit.java 7287 2006-03-30 21:21:55Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.email.api;
21:
22: import org.sakaiproject.entity.api.Edit;
23: import org.sakaiproject.time.api.Time;
24:
25: /**
26: * <p>
27: * DigestEdit is a mutable Digest.
28: * </p>
29: */
30: public interface DigestEdit extends Digest, Edit {
31: /**
32: * Add another message, in the current time period.
33: *
34: * @param subject
35: * The to (user id) of the message.
36: * @param subject
37: * The subject of the message.
38: * @param body
39: * The subject of the message.
40: */
41: void add(String to, String subject, String body);
42:
43: /**
44: * Add another message, in the current time period.
45: *
46: * @param msg
47: * The message to add.
48: */
49: void add(DigestMessage msg);
50:
51: /**
52: * Clear all messages from a time period.
53: *
54: * @param period
55: * a Time in the time period.
56: */
57: void clear(Time period);
58: }
|