org.sakaiproject.service.legacy.calendar
Interface CalendarEvent

All Superinterfaces:
AttachmentContainer, Comparable, Entity
All Known Subinterfaces:
CalendarEventEdit
All Known Implementing Classes:
BaseCalendarService.BaseCalendarEventEdit, GenericCalendarImporter.PrototypeEvent

public interface CalendarEvent
extends Entity, Comparable, AttachmentContainer

CalendarEvent is the interface for events placed into a CHEF Calendar Service Calendar.

Each event has a time range, and other information in the event's (Resource) properties.

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 getCalendarReference()
          Gets the containing calendar's reference.
 String getDescription()
          Access the description property as plain text (cover for PROP_DESCRIPTION).
 String getDescriptionFormatted()
          Access the description property as formatted text (cover for PROP_DESCRIPTION).
 String getDisplayName()
          Access the display name property (cover for PROP_DISPLAY_NAME).
 String getField(String name)
          Get the value of an "extra" event field.
 String getLocation()
          Access the location property (cover for PROP_CALENDAR_LOCATION).
 TimeRange getRange()
          Access the time range
 RecurrenceRule getRecurrenceRule()
          Gets the recurrence rule, if any.
 String getType()
          Access the type (cover for PROP_CALENDAR_TYPE).
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.AttachmentContainer
getAttachments
 

Method Detail

getRange

public TimeRange getRange()
Access the time range

Returns:
The event time range

getDisplayName

public String getDisplayName()
Access the display name property (cover for PROP_DISPLAY_NAME).

Returns:
The event's display name property.

getDescription

public String getDescription()
Access the description property as plain text (cover for PROP_DESCRIPTION).

Returns:
The event's description property.

getDescriptionFormatted

public String getDescriptionFormatted()
Access the description property as formatted text (cover for PROP_DESCRIPTION).

Returns:
The event's description property.

getType

public String getType()
Access the type (cover for PROP_CALENDAR_TYPE).

Returns:
The event's type property.

getLocation

public String getLocation()
Access the location property (cover for PROP_CALENDAR_LOCATION).

Returns:
The event's location property.

getField

public String getField(String name)
Get the value of an "extra" event field.

Parameters:
name - The name of the field.
Returns:
the value of the "extra" event field.

getCalendarReference

public String getCalendarReference()
Gets the containing calendar's reference.

Returns:
The containing calendar reference.

getRecurrenceRule

public RecurrenceRule getRecurrenceRule()
Gets the recurrence rule, if any.

Returns:
The recurrence rule, or null if none.