01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/email/tags/sakai_2-4-1/email-api/api/src/java/org/sakaiproject/email/api/Digest.java $
03: * $Id: Digest.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 java.util.List;
23:
24: import org.sakaiproject.entity.api.Entity;
25: import org.sakaiproject.time.api.Time;
26:
27: /**
28: * <p>
29: * Digest stores sets of messages for a given user (id).
30: * </p>
31: */
32: public interface Digest extends Entity, Comparable {
33: /**
34: * Access the (user) id for this digest.
35: *
36: * @return The (user) id for this digest.
37: */
38: String getId();
39:
40: /**
41: * Access the list (DigestMessage) of messages, for the time period.
42: *
43: * @param period
44: * A time in the time period to select.
45: * @return The List (DigestMessage) of messages (possibly empty).
46: */
47: List getMessages(Time period);
48:
49: /**
50: * Access the list (String, TimePeriod string) of periods.
51: *
52: * @return The List (String, TimePeriod string) of periods.
53: */
54: List getPeriods();
55: }
|