com.google.gdata.model.gd
Class RecurrenceExceptionEntry

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.RecurrenceExceptionEntry
All Implemented Interfaces:
IAtom, IEntry

public class RecurrenceExceptionEntry
extends Entry

Describes an entry used by a recurrence exception entry link.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gdata.model.atom.Entry
Entry.EntryState
 
Field Summary
static ElementKey<java.lang.Void,RecurrenceExceptionEntry> KEY
          The key for this element.
 
Fields inherited from class com.google.gdata.model.atom.Entry
ID, PUBLISHED, RIGHTS, state, SUMMARY, TITLE, UPDATED
 
Constructor Summary
  RecurrenceExceptionEntry()
          Constructs an instance using the default key.
protected RecurrenceExceptionEntry(ElementKey<?,? extends RecurrenceExceptionEntry> key)
          Subclass constructor, allows subclasses to supply their own element 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.
  RecurrenceExceptionEntry(Entry sourceEntry)
          Constructs a new instance by doing a shallow copy of data from an existing Entry instance.
 
Method Summary
 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.
 java.util.List<When> getWhen()
          Returns the time period descriptions.
 java.util.List<Where> getWhere()
          Returns the place descriptions.
 java.util.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.
 
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, narrow, 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
adapt, adapt, addElement, addElement, addElement, clear, createElement, createElement, eq, 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, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, validate, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY

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

Constructor Detail

RecurrenceExceptionEntry

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


RecurrenceExceptionEntry

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

Parameters:
sourceEntry - source entry

RecurrenceExceptionEntry

protected RecurrenceExceptionEntry(ElementKey<?,? extends RecurrenceExceptionEntry> key)
Subclass constructor, allows subclasses to supply their own element key.


RecurrenceExceptionEntry

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 Element.createElement(ElementKey, Element).

Parameters:
key - The key to use for this element.
source - source element
Method Detail

registerMetadata

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


lock

public RecurrenceExceptionEntry 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 Comments class.

Returns:
Comments class

setComments

public RecurrenceExceptionEntry setComments(Comments comments)
Sets the Comments class.

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

hasComments

public boolean hasComments()
Returns whether it has the Comments class.

Returns:
whether it has the Comments class

getEventStatus

public EventStatus getEventStatus()
Returns the event status.

Returns:
event status

setEventStatus

public RecurrenceExceptionEntry 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

getOriginalEvent

public OriginalEvent getOriginalEvent()
Returns the original event.

Returns:
original event

setOriginalEvent

public RecurrenceExceptionEntry setOriginalEvent(OriginalEvent originalEvent)
Sets the original event.

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

hasOriginalEvent

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

Returns:
whether it has the original event

getTransparency

public Transparency getTransparency()
Returns the event transparency.

Returns:
event transparency

setTransparency

public RecurrenceExceptionEntry 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 RecurrenceExceptionEntry 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

getWhen

public java.util.List<When> getWhen()
Returns the time period descriptions.

Returns:
time period descriptions

addWhen

public RecurrenceExceptionEntry addWhen(When when)
Adds a new time period description.

Parameters:
when - time period description

removeWhen

public boolean removeWhen(When when)
Removes an existing time period description.

Parameters:
when - time period description
Returns:
true if the when was removed

clearWhen

public void clearWhen()
Removes all existing time period description instances.


hasWhen

public boolean hasWhen()
Returns whether it has the time period descriptions.

Returns:
whether it has the time period descriptions

getWhere

public java.util.List<Where> getWhere()
Returns the place descriptions.

Returns:
place descriptions

addWhere

public RecurrenceExceptionEntry addWhere(Where where)
Adds a new place description.

Parameters:
where - place description

removeWhere

public boolean removeWhere(Where where)
Removes an existing place description.

Parameters:
where - place description
Returns:
true if the where was removed

clearWhere

public void clearWhere()
Removes all existing place description instances.


hasWhere

public boolean hasWhere()
Returns whether it has the place descriptions.

Returns:
whether it has the place descriptions

getWho

public java.util.List<Who> getWho()
Returns the person descriptions.

Returns:
person descriptions

addWho

public RecurrenceExceptionEntry addWho(Who who)
Adds a new person description.

Parameters:
who - person description

removeWho

public boolean removeWho(Who who)
Removes an existing person description.

Parameters:
who - person description
Returns:
true if the who was removed

clearWho

public void clearWho()
Removes all existing person description instances.


hasWho

public boolean hasWho()
Returns whether it has the person descriptions.

Returns:
whether it has the person descriptions