org.sakaiproject.service.legacy.calendar
Interface CalendarEventEdit

All Superinterfaces:
AttachmentContainer, AttachmentContainerEdit, CalendarEvent, Comparable, Edit, Entity
All Known Implementing Classes:
BaseCalendarService.BaseCalendarEventEdit, GenericCalendarImporter.PrototypeEvent

public interface CalendarEventEdit
extends CalendarEvent, Edit, AttachmentContainerEdit

CalendarEventEdit is an editable CalendarEvent

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
 void setDescription(String description)
          Set the description property as plain text (cover for PROP_DESCRIPTION).
 void setDescriptionFormatted(String description)
          Set the description property as formatted text (cover for PROP_DESCRIPTION).
 void setDisplayName(String name)
          Set the display name property (cover for PROP_DISPLAY_NAME).
 void setField(String name, String value)
          Set the value of an "extra" event field.
 void setLocation(String location)
          Set the location (cover for PROP_CALENDAR_LOCATION).
 void setRange(TimeRange range)
          Replace the time range
 void setRecurrenceRule(RecurrenceRule rule)
          Sets the recurrence rule.
 void setType(String type)
          Set the type (cover for PROP_CALENDAR_TYPE).
 
Methods inherited from interface org.sakaiproject.service.legacy.calendar.CalendarEvent
getCalendarReference, getDescription, getDescriptionFormatted, getDisplayName, getField, getLocation, getRange, getRecurrenceRule, getType
 
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
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Edit
getPropertiesEdit, isActiveEdit
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.AttachmentContainerEdit
addAttachment, clearAttachments, removeAttachment, replaceAttachments
 

Method Detail

setRange

public void setRange(TimeRange range)
Replace the time range


setDisplayName

public void setDisplayName(String name)
Set the display name property (cover for PROP_DISPLAY_NAME).

Parameters:
name - The event's display name property.

setDescription

public void setDescription(String description)
Set the description property as plain text (cover for PROP_DESCRIPTION).

Parameters:
description - The event's description property.

setDescriptionFormatted

public void setDescriptionFormatted(String description)
Set the description property as formatted text (cover for PROP_DESCRIPTION).

Parameters:
description - The event's description property.

setType

public void setType(String type)
Set the type (cover for PROP_CALENDAR_TYPE).

Parameters:
type - The event's type property.

setLocation

public void setLocation(String location)
Set the location (cover for PROP_CALENDAR_LOCATION).

Parameters:
location - The event's location property.

setField

public void setField(String name,
                     String value)
Set the value of an "extra" event field.

Parameters:
name - The "extra" field name
value - The value to set, or null to remove the field.

setRecurrenceRule

public void setRecurrenceRule(RecurrenceRule rule)
Sets the recurrence rule.

Parameters:
rule - The recurrence rule, or null to clear out the rule.