public class

EventEntry

extends Entry
java.lang.Object
   ↳ com.google.gdata.model.Element
     ↳ com.google.gdata.model.atom.Entry
       ↳ com.google.gdata.model.gd.EventEntry

Class Overview

Describes an event entry.

Summary

Constants
String KIND Event kind term value.
Fields
public static final Category CATEGORY Event kind category.
public static final ElementKey<Void, EventEntry> KEY The key for this element.
[Expand]
Inherited Fields
From class com.google.gdata.model.atom.Entry
From class com.google.gdata.model.Element
Public Constructors
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.
Protected Constructors
EventEntry(ElementKey<?, ? extends EventEntry> key)
Subclass constructor, allows subclasses to supply their own element key.
EventEntry(ElementKey<?, ? extends EventEntry> key, Entry source)
Constructs a new instance by doing a shallow copy of data from an existing Entry instance.
Public Methods
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.
List<Where> getLocations()
Returns the event locations.
OriginalEvent getOriginalEvent()
Returns the event original start time.
List<Who> getParticipants()
Returns the event participants.
Recurrence getRecurrence()
Returns the event recurrence.
List<RecurrenceException> getRecurrenceException()
Returns the recurrence exceptions.
List<Reminder> getReminders()
Returns the event reminders.
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.
[Expand]
Inherited Methods
From class com.google.gdata.model.atom.Entry
From class com.google.gdata.model.Element
From class java.lang.Object
From interface com.google.gdata.data.IAtom
From interface com.google.gdata.data.IEntry

Constants

public static final String KIND

Event kind term value.

Constant Value: "http://schemas.google.com/g/2005#event"

Fields

public static final Category CATEGORY

Event kind category.

public static final ElementKey<Void, EventEntry> KEY

The key for this element.

Public Constructors

public EventEntry ()

Constructs an instance using the default key.

public EventEntry (Entry sourceEntry)

Constructs a new instance by doing a shallow copy of data from an existing Entry instance.

Parameters
sourceEntry Source entry

Protected Constructors

protected EventEntry (ElementKey<?, ? extends EventEntry> key)

Subclass constructor, allows subclasses to supply their own element key.

Parameters
key

protected EventEntry (ElementKey<?, ? extends EventEntry> key, Entry source)

Constructs a new instance by doing a shallow copy of data from an existing Entry instance. Will use the given ElementKey as the key for the element. This constructor is used when adapting from one element key to another. You cannot call this constructor directly, instead use createElement(ElementKey, Element).

Parameters
key The key to use for this element.
source Source element

Public Methods

public EventEntry addLocation (Where location)

Adds a new event location.

Parameters
location Event location

public EventEntry addParticipant (Who participant)

Adds a new event participant.

Parameters
participant Event participant

public EventEntry addRecurrenceException (RecurrenceException recurrenceException)

Adds a new recurrence exception.

Parameters
recurrenceException Recurrence exception

public EventEntry addReminder (Reminder reminder)

Adds a new event reminder.

Parameters
reminder Event reminder

public EventEntry addTime (When time)

Adds a new event time.

Parameters
time Event time

public void clearLocations ()

Removes all existing event location instances.

public void clearParticipants ()

Removes all existing event participant instances.

public void clearRecurrenceException ()

Removes all existing recurrence exception instances.

public void clearReminders ()

Removes all existing event reminder instances.

public void clearTimes ()

Removes all existing event time instances.

public Comments getComments ()

Returns the nested comments feed.

Returns
  • nested comments feed

public EventStatus getEventStatus ()

Returns the event status.

Returns
  • event status

public List<Where> getLocations ()

Returns the event locations.

Returns
  • event locations

public OriginalEvent getOriginalEvent ()

Returns the event original start time.

Returns
  • event original start time

public List<Who> getParticipants ()

Returns the event participants.

Returns
  • event participants

public Recurrence getRecurrence ()

Returns the event recurrence.

Returns
  • event recurrence

public List<RecurrenceException> getRecurrenceException ()

Returns the recurrence exceptions.

Returns
  • recurrence exceptions

public List<Reminder> getReminders ()

Returns the event reminders.

Returns
  • event reminders

public List<When> getTimes ()

Returns the event times.

Returns
  • event times

public Transparency getTransparency ()

Returns the event transparency.

Returns
  • event transparency

public Visibility getVisibility ()

Returns the event visibility.

Returns
  • event visibility

public boolean hasComments ()

Returns whether it has the nested comments feed.

Returns
  • whether it has the nested comments feed

public boolean hasEventStatus ()

Returns whether it has the event status.

Returns
  • whether it has the event status

public boolean hasLocations ()

Returns whether it has the event locations.

Returns
  • whether it has the event locations

public boolean hasOriginalEvent ()

Returns whether it has the event original start time.

Returns
  • whether it has the event original start time

public boolean hasParticipants ()

Returns whether it has the event participants.

Returns
  • whether it has the event participants

public boolean hasRecurrence ()

Returns whether it has the event recurrence.

Returns
  • whether it has the event recurrence

public boolean hasRecurrenceException ()

Returns whether it has the recurrence exceptions.

Returns
  • whether it has the recurrence exceptions

public boolean hasReminders ()

Returns whether it has the event reminders.

Returns
  • whether it has the event reminders

public boolean hasTimes ()

Returns whether it has the event times.

Returns
  • whether it has the event times

public boolean hasTransparency ()

Returns whether it has the event transparency.

Returns
  • whether it has the event transparency

public boolean hasVisibility ()

Returns whether it has the event visibility.

Returns
  • whether it has the event visibility

public EventEntry lock ()

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.

public static void registerMetadata (MetadataRegistry registry)

Registers the metadata for this element.

Parameters
registry

public boolean removeLocation (Where location)

Removes an existing event location.

Parameters
location Event location
Returns
  • true if the location was removed

public boolean removeParticipant (Who participant)

Removes an existing event participant.

Parameters
participant Event participant
Returns
  • true if the participant was removed

public boolean removeRecurrenceException (RecurrenceException recurrenceException)

Removes an existing recurrence exception.

Parameters
recurrenceException Recurrence exception
Returns
  • true if the recurrenceException was removed

public boolean removeReminder (Reminder reminder)

Removes an existing event reminder.

Parameters
reminder Event reminder
Returns
  • true if the reminder was removed

public boolean removeTime (When time)

Removes an existing event time.

Parameters
time Event time
Returns
  • true if the time was removed

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

public EventEntry setEventStatus (EventStatus eventStatus)

Sets the event status.

Parameters
eventStatus Event status or null to reset
Returns
  • this to enable chaining setters

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

public EventEntry setRecurrence (Recurrence recurrence)

Sets the event recurrence.

Parameters
recurrence Event recurrence or null to reset
Returns
  • this to enable chaining setters

public EventEntry setTransparency (Transparency transparency)

Sets the event transparency.

Parameters
transparency Event transparency or null to reset
Returns
  • this to enable chaining setters

public EventEntry setVisibility (Visibility visibility)

Sets the event visibility.

Parameters
visibility Event visibility or null to reset
Returns
  • this to enable chaining setters