com.google.gdata.model.gd
Class EventEntry

java.lang.Object
  extended by com.google.gdata.model.Element
      extended by com.google.gdata.model.atom.Entry
          extended by com.google.gdata.model.gd.EventEntry
All Implemented Interfaces:
IAtom, IEntry

public class EventEntry
extends Entry

Describes an event entry.


Field Summary
static Category CATEGORY
          Event kind category.
static ElementKey<java.lang.Void,EventEntry> KEY
          The key for this element.
static java.lang.String KIND
          Event kind term value.
 
Fields inherited from class com.google.gdata.model.atom.Entry
ID, PUBLISHED, RIGHTS, SUMMARY, TITLE, UPDATED
 
Constructor Summary
EventEntry()
          Constructs an instance using the default key.
EventEntry(Entry sourceEntry)
          Constructs a new instance by doing a shallow copy of data from an existing Entry instance.
 
Method Summary
 EventEntry addLocation(Where location)
          Adds a new event location.
 EventEntry addParticipant(Who participant)
          Adds a new event participant.
 EventEntry addRecurrenceException(RecurrenceException recurrenceException)
          Adds a new recurrence exception.
 EventEntry addReminder(Reminder reminder)
          Adds a new event reminder.
 EventEntry addTime(When time)
          Adds a new event time.
 void clearLocations()
          Removes all existing event location instances.
 void clearParticipants()
          Removes all existing event participant instances.
 void clearRecurrenceException()
          Removes all existing recurrence exception instances.
 void clearReminders()
          Removes all existing event reminder instances.
 void clearTimes()
          Removes all existing event time instances.
 Comments getComments()
          Returns the nested comments feed.
 EventStatus getEventStatus()
          Returns the event status.
 java.util.List<Where> getLocations()
          Returns the event locations.
 OriginalEvent getOriginalEvent()
          Returns the event original start time.
 java.util.List<Who> getParticipants()
          Returns the event participants.
 Recurrence getRecurrence()
          Returns the event recurrence.
 java.util.List<RecurrenceException> getRecurrenceException()
          Returns the recurrence exceptions.
 java.util.List<Reminder> getReminders()
          Returns the event reminders.
 java.util.List<When> getTimes()
          Returns the event times.
 Transparency getTransparency()
          Returns the event transparency.
 Visibility getVisibility()
          Returns the event visibility.
 boolean hasComments()
          Returns whether it has the nested comments feed.
 boolean hasEventStatus()
          Returns whether it has the event status.
 boolean hasLocations()
          Returns whether it has the event locations.
 boolean hasOriginalEvent()
          Returns whether it has the event original start time.
 boolean hasParticipants()
          Returns whether it has the event participants.
 boolean hasRecurrence()
          Returns whether it has the event recurrence.
 boolean hasRecurrenceException()
          Returns whether it has the recurrence exceptions.
 boolean hasReminders()
          Returns whether it has the event reminders.
 boolean hasTimes()
          Returns whether it has the event times.
 boolean hasTransparency()
          Returns whether it has the event transparency.
 boolean hasVisibility()
          Returns whether it has the event visibility.
 EventEntry lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 boolean removeLocation(Where location)
          Removes an existing event location.
 boolean removeParticipant(Who participant)
          Removes an existing event participant.
 boolean removeRecurrenceException(RecurrenceException recurrenceException)
          Removes an existing recurrence exception.
 boolean removeReminder(Reminder reminder)
          Removes an existing event reminder.
 boolean removeTime(When time)
          Removes an existing event time.
 EventEntry setComments(Comments comments)
          Sets the nested comments feed.
 EventEntry setEventStatus(EventStatus eventStatus)
          Sets the event status.
 EventEntry setOriginalEvent(OriginalEvent originalEvent)
          Sets the event original start time.
 EventEntry setRecurrence(Recurrence recurrence)
          Sets the event recurrence.
 EventEntry setTransparency(Transparency transparency)
          Sets the event transparency.
 EventEntry setVisibility(Visibility visibility)
          Sets the event visibility.
 
Methods inherited from class com.google.gdata.model.atom.Entry
addAuthor, addCategory, addContributor, addHtmlLink, addLink, addLink, clearAuthors, clearCategories, clearContributors, delete, getAuthors, getCanEdit, getCategories, getContent, getContributors, getControl, getEdited, getEditLink, getEtag, getHtmlLink, getId, getKind, getLink, getLinks, getLinks, getMediaEditLink, getPlainTextContent, getPublished, getResumableEditMediaLink, getRights, getSelectedFields, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, hasControl, isDraft, removeAuthor, removeContent, removeContributor, removeLink, removeLinks, removeLinks, setCanEdit, setContent, setControl, setDraft, setEdited, setEtag, setId, setKind, setPublished, setRights, setSelectedFields, setService, setSource, setSummary, setTitle, setUpdated, setVersionId, update
 
Methods inherited from class com.google.gdata.model.Element
addElement, addElement, addElement, clear, createElement, createElement, equals, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hashCode, hasTextValue, isLocked, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, visit
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KIND

public static final java.lang.String KIND
Event kind term value.

See Also:
Constant Field Values

CATEGORY

public static final Category CATEGORY
Event kind category.


KEY

public static final ElementKey<java.lang.Void,EventEntry> KEY
The key for this element.

Constructor Detail

EventEntry

public EventEntry()
Constructs an instance using the default key.


EventEntry

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

Parameters:
sourceEntry - source entry
Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.


lock

public EventEntry lock()
Description copied from class: Element
Locks this element. A locked element cannot have any changes made to its content or its attributes or child elements. This will also lock all attributes and child elements as well. Once this method has been called, this element can be safely published to other threads.

Overrides:
lock in class Element

getComments

public Comments getComments()
Returns the nested comments feed.

Returns:
nested comments feed

setComments

public EventEntry setComments(Comments comments)
Sets the nested comments feed.

Parameters:
comments - nested comments feed or null to reset
Returns:
this to enable chaining setters

hasComments

public boolean hasComments()
Returns whether it has the nested comments feed.

Returns:
whether it has the nested comments feed

getEventStatus

public EventStatus getEventStatus()
Returns the event status.

Returns:
event status

setEventStatus

public EventEntry setEventStatus(EventStatus eventStatus)
Sets the event status.

Parameters:
eventStatus - event status or null to reset
Returns:
this to enable chaining setters

hasEventStatus

public boolean hasEventStatus()
Returns whether it has the event status.

Returns:
whether it has the event status

getLocations

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

Returns:
event locations

addLocation

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

Parameters:
location - event location

removeLocation

public boolean removeLocation(Where location)
Removes an existing event location.

Parameters:
location - event location
Returns:
true if the location was removed

clearLocations

public void clearLocations()
Removes all existing event location instances.


hasLocations

public boolean hasLocations()
Returns whether it has the event locations.

Returns:
whether it has the event locations

getOriginalEvent

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

Returns:
event original start time

setOriginalEvent

public EventEntry setOriginalEvent(OriginalEvent originalEvent)
Sets the event original start time.

Parameters:
originalEvent - event original start time or null to reset
Returns:
this to enable chaining setters

hasOriginalEvent

public boolean hasOriginalEvent()
Returns whether it has the event original start time.

Returns:
whether it has the event original start time

getParticipants

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

Returns:
event participants

addParticipant

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

Parameters:
participant - event participant

removeParticipant

public boolean removeParticipant(Who participant)
Removes an existing event participant.

Parameters:
participant - event participant
Returns:
true if the participant was removed

clearParticipants

public void clearParticipants()
Removes all existing event participant instances.


hasParticipants

public boolean hasParticipants()
Returns whether it has the event participants.

Returns:
whether it has the event participants

getRecurrence

public Recurrence getRecurrence()
Returns the event recurrence.

Returns:
event recurrence

setRecurrence

public EventEntry setRecurrence(Recurrence recurrence)
Sets the event recurrence.

Parameters:
recurrence - event recurrence or null to reset
Returns:
this to enable chaining setters

hasRecurrence

public boolean hasRecurrence()
Returns whether it has the event recurrence.

Returns:
whether it has the event recurrence

getRecurrenceException

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

Returns:
recurrence exceptions

addRecurrenceException

public EventEntry addRecurrenceException(RecurrenceException recurrenceException)
Adds a new recurrence exception.

Parameters:
recurrenceException - recurrence exception

removeRecurrenceException

public boolean removeRecurrenceException(RecurrenceException recurrenceException)
Removes an existing recurrence exception.

Parameters:
recurrenceException - recurrence exception
Returns:
true if the recurrenceException was removed

clearRecurrenceException

public void clearRecurrenceException()
Removes all existing recurrence exception instances.


hasRecurrenceException

public boolean hasRecurrenceException()
Returns whether it has the recurrence exceptions.

Returns:
whether it has the recurrence exceptions

getReminders

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

Returns:
event reminders

addReminder

public EventEntry addReminder(Reminder reminder)
Adds a new event reminder.

Parameters:
reminder - event reminder

removeReminder

public boolean removeReminder(Reminder reminder)
Removes an existing event reminder.

Parameters:
reminder - event reminder
Returns:
true if the reminder was removed

clearReminders

public void clearReminders()
Removes all existing event reminder instances.


hasReminders

public boolean hasReminders()
Returns whether it has the event reminders.

Returns:
whether it has the event reminders

getTimes

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

Returns:
event times

addTime

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

Parameters:
time - event time

removeTime

public boolean removeTime(When time)
Removes an existing event time.

Parameters:
time - event time
Returns:
true if the time was removed

clearTimes

public void clearTimes()
Removes all existing event time instances.


hasTimes

public boolean hasTimes()
Returns whether it has the event times.

Returns:
whether it has the event times

getTransparency

public Transparency getTransparency()
Returns the event transparency.

Returns:
event transparency

setTransparency

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

Parameters:
transparency - event transparency or null to reset
Returns:
this to enable chaining setters

hasTransparency

public boolean hasTransparency()
Returns whether it has the event transparency.

Returns:
whether it has the event transparency

getVisibility

public Visibility getVisibility()
Returns the event visibility.

Returns:
event visibility

setVisibility

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

Parameters:
visibility - event visibility or null to reset
Returns:
this to enable chaining setters

hasVisibility

public boolean hasVisibility()
Returns whether it has the event visibility.

Returns:
whether it has the event visibility