public class

RecurrenceExceptionEntry

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

Class Overview

Describes an entry used by a recurrence exception entry link.

Summary

Fields
public static final ElementKey<Void, RecurrenceExceptionEntry> 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
RecurrenceExceptionEntry()
Constructs an instance using the default key.
RecurrenceExceptionEntry(Entry sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing Entry instance.
Protected Constructors
RecurrenceExceptionEntry(ElementKey<?, ? extends RecurrenceExceptionEntry> key)
Subclass constructor, allows subclasses to supply their own element key.
RecurrenceExceptionEntry(ElementKey<?, ? extends RecurrenceExceptionEntry> key, Entry source)
Constructs a new instance by doing a shallow copy of data from an existing Entry instance.
Public Methods
RecurrenceExceptionEntry addWhen(When when)
Adds a new time period description.
RecurrenceExceptionEntry addWhere(Where where)
Adds a new place description.
RecurrenceExceptionEntry addWho(Who who)
Adds a new person description.
void clearWhen()
Removes all existing time period description instances.
void clearWhere()
Removes all existing place description instances.
void clearWho()
Removes all existing person description instances.
Comments getComments()
Returns the Comments class.
EventStatus getEventStatus()
Returns the event status.
OriginalEvent getOriginalEvent()
Returns the original event.
Transparency getTransparency()
Returns the event transparency.
Visibility getVisibility()
Returns the event visibility.
List<When> getWhen()
Returns the time period descriptions.
List<Where> getWhere()
Returns the place descriptions.
List<Who> getWho()
Returns the person descriptions.
boolean hasComments()
Returns whether it has the Comments class.
boolean hasEventStatus()
Returns whether it has the event status.
boolean hasOriginalEvent()
Returns whether it has the original event.
boolean hasTransparency()
Returns whether it has the event transparency.
boolean hasVisibility()
Returns whether it has the event visibility.
boolean hasWhen()
Returns whether it has the time period descriptions.
boolean hasWhere()
Returns whether it has the place descriptions.
boolean hasWho()
Returns whether it has the person descriptions.
RecurrenceExceptionEntry lock()
Locks this element.
static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
boolean removeWhen(When when)
Removes an existing time period description.
boolean removeWhere(Where where)
Removes an existing place description.
boolean removeWho(Who who)
Removes an existing person description.
RecurrenceExceptionEntry setComments(Comments comments)
Sets the Comments class.
RecurrenceExceptionEntry setEventStatus(EventStatus eventStatus)
Sets the event status.
RecurrenceExceptionEntry setOriginalEvent(OriginalEvent originalEvent)
Sets the original event.
RecurrenceExceptionEntry setTransparency(Transparency transparency)
Sets the event transparency.
RecurrenceExceptionEntry 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

Fields

public static final ElementKey<Void, RecurrenceExceptionEntry> KEY

The key for this element.

Public Constructors

public RecurrenceExceptionEntry ()

Constructs an instance using the default key.

public RecurrenceExceptionEntry (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 RecurrenceExceptionEntry (ElementKey<?, ? extends RecurrenceExceptionEntry> key)

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

Parameters
key

protected RecurrenceExceptionEntry (ElementKey<?, ? extends RecurrenceExceptionEntry> 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 RecurrenceExceptionEntry addWhen (When when)

Adds a new time period description.

Parameters
when Time period description

public RecurrenceExceptionEntry addWhere (Where where)

Adds a new place description.

Parameters
where Place description

public RecurrenceExceptionEntry addWho (Who who)

Adds a new person description.

Parameters
who Person description

public void clearWhen ()

Removes all existing time period description instances.

public void clearWhere ()

Removes all existing place description instances.

public void clearWho ()

Removes all existing person description instances.

public Comments getComments ()

Returns the Comments class.

Returns
  • Comments class

public EventStatus getEventStatus ()

Returns the event status.

Returns
  • event status

public OriginalEvent getOriginalEvent ()

Returns the original event.

Returns
  • original event

public Transparency getTransparency ()

Returns the event transparency.

Returns
  • event transparency

public Visibility getVisibility ()

Returns the event visibility.

Returns
  • event visibility

public List<When> getWhen ()

Returns the time period descriptions.

Returns
  • time period descriptions

public List<Where> getWhere ()

Returns the place descriptions.

Returns
  • place descriptions

public List<Who> getWho ()

Returns the person descriptions.

Returns
  • person descriptions

public boolean hasComments ()

Returns whether it has the Comments class.

Returns
  • whether it has the Comments class

public boolean hasEventStatus ()

Returns whether it has the event status.

Returns
  • whether it has the event status

public boolean hasOriginalEvent ()

Returns whether it has the original event.

Returns
  • whether it has the original event

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 boolean hasWhen ()

Returns whether it has the time period descriptions.

Returns
  • whether it has the time period descriptions

public boolean hasWhere ()

Returns whether it has the place descriptions.

Returns
  • whether it has the place descriptions

public boolean hasWho ()

Returns whether it has the person descriptions.

Returns
  • whether it has the person descriptions

public RecurrenceExceptionEntry 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 removeWhen (When when)

Removes an existing time period description.

Parameters
when Time period description
Returns
  • true if the when was removed

public boolean removeWhere (Where where)

Removes an existing place description.

Parameters
where Place description
Returns
  • true if the where was removed

public boolean removeWho (Who who)

Removes an existing person description.

Parameters
who Person description
Returns
  • true if the who was removed

public RecurrenceExceptionEntry setComments (Comments comments)

Sets the Comments class.

Parameters
comments Comments class or null to reset
Returns
  • this to enable chaining setters

public RecurrenceExceptionEntry setEventStatus (EventStatus eventStatus)

Sets the event status.

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

public RecurrenceExceptionEntry setOriginalEvent (OriginalEvent originalEvent)

Sets the original event.

Parameters
originalEvent Original event or null to reset
Returns
  • this to enable chaining setters

public RecurrenceExceptionEntry setTransparency (Transparency transparency)

Sets the event transparency.

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

public RecurrenceExceptionEntry setVisibility (Visibility visibility)

Sets the event visibility.

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