org.sakaiproject.service.legacy.digest
Interface Digest

All Superinterfaces:
Comparable, Entity
All Known Subinterfaces:
DigestEdit
All Known Implementing Classes:
BaseDigestService.BaseDigest

public interface Digest
extends Entity, Comparable

Digest stores sets of messages for a given user (id).

Version:
$Revision: 2371 $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 String getId()
          Access the (user) id for this digest.
 List getMessages(Time period)
          Access the list (DigestMessage) of messages, for the time period.
 List getPeriods()
          Access the list (String, TimePeriod string) of periods.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

public String getId()
Access the (user) id for this digest.

Specified by:
getId in interface Entity
Returns:
The (user) id for this digest.

getMessages

public List getMessages(Time period)
Access the list (DigestMessage) of messages, for the time period.

Parameters:
period - A time in the time period to select.
Returns:
The List (DigestMessage) of messages (possibly empty).

getPeriods

public List getPeriods()
Access the list (String, TimePeriod string) of periods.

Returns:
The List (String, TimePeriod string) of periods.