public class

Reminder

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

Class Overview

Describes a reminder on an event.

Summary

Nested Classes
class Reminder.Method Method. 
Fields
public static final AttributeKey<DateTime> ABSOLUTE_TIME Absolute time of the reminder.
public static final AttributeKey<Integer> DAYS Number of days before the start time.
public static final AttributeKey<Integer> HOURS Number of hours before the start time.
public static final ElementKey<Void, Reminder> KEY The key for this element.
public static final AttributeKey<String> METHOD Method.
public static final AttributeKey<Integer> MINUTES Number of minute before the start times.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
Reminder()
Constructs an instance using the default key.
Protected Constructors
Reminder(ElementKey<?, ? extends Reminder> key)
Subclass constructor, allows subclasses to supply their own element key.
Reminder(ElementKey<?, ? extends Reminder> key, Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance.
Public Methods
boolean equals(Object obj)
DateTime getAbsoluteTime()
Returns the absolute time of the reminder.
Integer getDays()
Returns the number of days before the start time.
Integer getHours()
Returns the number of hours before the start time.
String getMethod()
Returns the method.
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.
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.
int hashCode()
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(Integer days)
Sets the number of days before the start time.
Reminder setHours(Integer hours)
Sets the number of hours before the start time.
Reminder setMethod(String method)
Sets the method.
Reminder setMinutes(Integer minutes)
Sets the number of minute before the start times.
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object

Fields

public static final AttributeKey<DateTime> ABSOLUTE_TIME

Absolute time of the reminder.

public static final AttributeKey<Integer> DAYS

Number of days before the start time.

public static final AttributeKey<Integer> HOURS

Number of hours before the start time.

public static final ElementKey<Void, Reminder> KEY

The key for this element.

public static final AttributeKey<String> METHOD

Method.

public static final AttributeKey<Integer> MINUTES

Number of minute before the start times.

Public Constructors

public Reminder ()

Constructs an instance using the default key.

Protected Constructors

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

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

Parameters
key

protected Reminder (ElementKey<?, ? extends Reminder> key, Element source)

Constructs a new instance by doing a shallow copy of data from an existing Element 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 boolean equals (Object obj)

Parameters
obj

public DateTime getAbsoluteTime ()

Returns the absolute time of the reminder.

Returns
  • absolute time of the reminder

public Integer getDays ()

Returns the number of days before the start time.

Returns
  • number of days before the start time

public Integer getHours ()

Returns the number of hours before the start time.

Returns
  • number of hours before the start time

public String getMethod ()

Returns the method.

Returns
  • method

public Integer getMinutes ()

Returns the number of minute before the start times.

Returns
  • number of minute before the start times

public boolean hasAbsoluteTime ()

Returns whether it has the absolute time of the reminder.

Returns
  • whether it has the absolute time of the reminder

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

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

public boolean hasMethod ()

Returns whether it has the method.

Returns
  • whether it has the method

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

public int hashCode ()

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

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

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

public Reminder setMethod (String method)

Sets the method.

Parameters
method Method or null to reset
Returns
  • this to enable chaining setters

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