com.google.gdata.data.extensions
Class EventEntry

java.lang.Object
  extended by com.google.gdata.data.ExtensionPoint
      extended by com.google.gdata.data.BaseEntry<EventEntry>
          extended by com.google.gdata.data.extensions.EventEntry
Direct Known Subclasses:
CalendarEventEntry

public class EventEntry
extends BaseEntry<EventEntry>

Extension class for manipulating entries of the Event kind.


Nested Class Summary
static class EventEntry.EventStatus
          Defines the base set of values for event status.
static class EventEntry.Transparency
          Defines the base set of values for event transparency.
static class EventEntry.Visibility
          Defines the base set of values for event visibility.
 
Nested classes/interfaces inherited from class com.google.gdata.data.BaseEntry
BaseEntry.AtomHandler
 
Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler, ExtensionPoint.Manifest
 
Field Summary
static Category EVENT_CATEGORY
          Category used to label entries that contain Event extension data.
 
Fields inherited from class com.google.gdata.data.BaseEntry
authors, canEdit, categories, content, contributors, id, isDraft, links, published, rights, service, source, summary, title, updated, versionId
 
Fields inherited from class com.google.gdata.data.ExtensionPoint
xmlBlob
 
Constructor Summary
EventEntry()
          Constructs a new EventEntry instance with the appropriate category to indicate that it is an event.
EventEntry(BaseEntry sourceEntry)
          Constructs a new EventEntry instance by doing a shallow copy of data from an existing BaseEntry instance.
 
Method Summary
 void addLocation(Where location)
          Adds a new event location.
 void addParticipant(Who participant)
          Adds a new event participant.
 void addRecurrenceException(RecurrenceException exception)
          Adds a new recurrence exception.
 void addTime(When time)
          Adds a new event time.
 void declareExtensions(ExtensionProfile extProfile)
          Initializes an ExtensionProfile based upon the extensions expected by an EventEntry.
 java.util.List<Where> getLocations()
          Returns the list of event locations
 OriginalEvent getOriginalEvent()
          Returns the event original start time.
 java.util.List<Who> getParticipants()
          Returns the list of event participants.
 Recurrence getRecurrence()
          Returns the event recurrence.
 java.util.List<RecurrenceException> getRecurrenceException()
          Returns the list of recurrence exceptions.
 java.util.List<Reminder> getReminder()
          Returns event reminders.
 EventEntry.EventStatus getStatus()
          Returns the event status.
 java.util.List<When> getTimes()
          Returns the list of event times.
 EventEntry.Transparency getTransparency()
          Returns the event transparency.
 EventEntry.Visibility getVisibility()
          Returns the event visibility.
 void setOriginalEvent(OriginalEvent v)
          Sets the event original start time.
 void setRecurrence(Recurrence v)
          Sets the event recurrence.
 void setStatus(EventEntry.EventStatus status)
          Sets the event status.
 void setTransparency(EventEntry.Transparency transparency)
          Sets the event transparency.
 void setVisibility(EventEntry.Visibility v)
          Sets the event visibility.
 
Methods inherited from class com.google.gdata.data.BaseEntry
addHtmlLink, delete, generateAtom, generateRss, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEditLink, getHtmlLink, getId, getLink, getLinks, getPublished, getRights, getSelf, getSelfLink, getService, getSource, getSummary, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, setCanEdit, setContent, setContent, setDraft, setId, setPublished, setRights, setService, setSource, setSummary, setTitle, setUpdated, setVersionId, update
 
Methods inherited from class com.google.gdata.data.ExtensionPoint
addExtension, addRepeatingExtension, checkRequiredExtensions, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionHandler, getManifest, getRepeatingExtension, getXmlBlob, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EVENT_CATEGORY

public static final Category EVENT_CATEGORY
Category used to label entries that contain Event extension data.

Constructor Detail

EventEntry

public EventEntry()
Constructs a new EventEntry instance with the appropriate category to indicate that it is an event.


EventEntry

public EventEntry(BaseEntry sourceEntry)
Constructs a new EventEntry instance by doing a shallow copy of data from an existing BaseEntry instance.

Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)
Initializes an ExtensionProfile based upon the extensions expected by an EventEntry.

Specified by:
declareExtensions in class BaseEntry<EventEntry>
Parameters:
extProfile - the ExtensionProfile to initialize.

getTimes

public java.util.List<When> getTimes()
Returns the list of event times.


addTime

public void addTime(When time)
Adds a new event time.


getLocations

public java.util.List<Where> getLocations()
Returns the list of event locations


addLocation

public void addLocation(Where location)
Adds a new event location.


getStatus

public EventEntry.EventStatus getStatus()
Returns the event status.


setStatus

public void setStatus(EventEntry.EventStatus status)
Sets the event status.


getVisibility

public EventEntry.Visibility getVisibility()
Returns the event visibility.


setVisibility

public void setVisibility(EventEntry.Visibility v)
Sets the event visibility.


getTransparency

public EventEntry.Transparency getTransparency()
Returns the event transparency.


setTransparency

public void setTransparency(EventEntry.Transparency transparency)
Sets the event transparency.


getParticipants

public java.util.List<Who> getParticipants()
Returns the list of event participants.


addParticipant

public void addParticipant(Who participant)
Adds a new event participant.


getRecurrence

public Recurrence getRecurrence()
Returns the event recurrence.


setRecurrence

public void setRecurrence(Recurrence v)
Sets the event recurrence.


getRecurrenceException

public java.util.List<RecurrenceException> getRecurrenceException()
Returns the list of recurrence exceptions.


addRecurrenceException

public void addRecurrenceException(RecurrenceException exception)
Adds a new recurrence exception.


getOriginalEvent

public OriginalEvent getOriginalEvent()
Returns the event original start time.


setOriginalEvent

public void setOriginalEvent(OriginalEvent v)
Sets the event original start time.


getReminder

public java.util.List<Reminder> getReminder()
Returns event reminders.