com.google.gdata.model.gd
Class Reminder

java.lang.Object
  com.google.gdata.model.Element
      com.google.gdata.model.gd.Reminder

public class Reminder
extends Element

Describes a reminder on an event.

Nested Class Summary

static class

Reminder.Method Method.

Field Summary

static AttributeKey<DateTime>	ABSOLUTE_TIME Absolute time of the reminder.
static AttributeKey<java.lang.Integer>	DAYS Number of days before the start time.
static AttributeKey<java.lang.Integer>	HOURS Number of hours before the start time.
static ElementKey<java.lang.Void,Reminder>	KEY The key for this element.
static AttributeKey<java.lang.String>	METHOD Method.
static AttributeKey<java.lang.Integer>	MINUTES Number of minute before the start times.

Constructor Summary

Reminder()
Constructs an instance using the default key.

Method Summary

boolean	equals(java.lang.Object obj)
DateTime	getAbsoluteTime() Returns the absolute time of the reminder.
java.lang.Integer	getDays() Returns the number of days before the start time.
java.lang.Integer	getHours() Returns the number of hours before the start time.
java.lang.String	getMethod() Returns the method.
java.lang.Integer	getMinutes() Returns the number of minute before the start times.
boolean	hasAbsoluteTime() Returns whether it has the absolute time of the reminder.
boolean	hasDays() Returns whether it has the number of days before the start time.
int	hashCode()
boolean	hasHours() Returns whether it has the number of hours before the start time.
boolean	hasMethod() Returns whether it has the method.
boolean	hasMinutes() Returns whether it has the number of minute before the start times.
Reminder	lock() Locks this element.
static void	registerMetadata(MetadataRegistry registry) Registers the metadata for this element.
Reminder	setAbsoluteTime(DateTime absoluteTime) Sets the absolute time of the reminder.
Reminder	setDays(java.lang.Integer days) Sets the number of days before the start time.
Reminder	setHours(java.lang.Integer hours) Sets the number of hours before the start time.
Reminder	setMethod(java.lang.String method) Sets the method.
Reminder	setMinutes(java.lang.Integer minutes) Sets the number of minute before the start times.

Methods inherited from class com.google.gdata.model.Element

addElement, addElement, addElement, clear, createElement, createElement, 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, 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

KEY

public static final ElementKey<java.lang.Void,Reminder> KEY

The key for this element.

ABSOLUTE_TIME

public static final AttributeKey<DateTime> ABSOLUTE_TIME

Absolute time of the reminder.

DAYS

public static final AttributeKey<java.lang.Integer> DAYS

Number of days before the start time.

HOURS

public static final AttributeKey<java.lang.Integer> HOURS

Number of hours before the start time.

METHOD

public static final AttributeKey<java.lang.String> METHOD

Method.

MINUTES

public static final AttributeKey<java.lang.Integer> MINUTES

Number of minute before the start times.

Constructor Detail

Reminder

public Reminder()

Constructs an instance using the default key.

Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)

Registers the metadata for this element.

lock

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

getAbsoluteTime

public DateTime getAbsoluteTime()

Returns the absolute time of the reminder.

Returns:

absolute time of the reminder

setAbsoluteTime

public Reminder setAbsoluteTime(DateTime absoluteTime)

Sets the absolute time of the reminder.

Parameters:

absoluteTime - absolute time of the reminder or null to reset

Returns:

this to enable chaining setters

hasAbsoluteTime

public boolean hasAbsoluteTime()

Returns whether it has the absolute time of the reminder.

Returns:

whether it has the absolute time of the reminder

getDays

public java.lang.Integer getDays()

Returns the number of days before the start time.

Returns:

number of days before the start time

setDays

public Reminder setDays(java.lang.Integer days)

Sets the number of days before the start time.

Parameters:

days - number of days before the start time or null to reset

Returns:

this to enable chaining setters

hasDays

public boolean hasDays()

Returns whether it has the number of days before the start time.

Returns:

whether it has the number of days before the start time

getHours

public java.lang.Integer getHours()

Returns the number of hours before the start time.

Returns:

number of hours before the start time

setHours

public Reminder setHours(java.lang.Integer hours)

Sets the number of hours before the start time.

Parameters:

hours - number of hours before the start time or null to reset

Returns:

this to enable chaining setters

hasHours

public boolean hasHours()

Returns whether it has the number of hours before the start time.

Returns:

whether it has the number of hours before the start time

getMethod

public java.lang.String getMethod()

Returns the method.

Returns:

method

setMethod

public Reminder setMethod(java.lang.String method)

Sets the method.

Parameters:

method - method or null to reset

Returns:

this to enable chaining setters

hasMethod

public boolean hasMethod()

Returns whether it has the method.

Returns:

whether it has the method

getMinutes

public java.lang.Integer getMinutes()

Returns the number of minute before the start times.

Returns:

number of minute before the start times

setMinutes

public Reminder setMinutes(java.lang.Integer minutes)

Sets the number of minute before the start times.

Parameters:

minutes - number of minute before the start times or null to reset

Returns:

this to enable chaining setters

hasMinutes

public boolean hasMinutes()

Returns whether it has the number of minute before the start times.

Returns:

whether it has the number of minute before the start times

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Element

hashCode

public int hashCode()

Overrides:

hashCode in class Element