com.funambol.common.pim.model.calendar
Class Reminder

java.lang.Object
  extended by com.funambol.common.pim.model.common.Property
      extended by com.funambol.common.pim.model.common.PropertyWithTimeZone
          extended by com.funambol.common.pim.model.calendar.Reminder

public class Reminder
extends PropertyWithTimeZone

This class represents the reminder of an event or task.

Version:
$Id: Reminder.java,v 1.3 2008-04-10 10:49:22 mauro Exp $

Field Summary
 
Fields inherited from class com.funambol.common.pim.model.common.PropertyWithTimeZone
timeZone
 
Fields inherited from class com.funambol.common.pim.model.common.Property
altrep, chrset, cn, cutype, delegatedFrom, delegatedTo, dir, encoding, group, language, member, partstat, propertyValue, related, sentby, tag, type, value, xParams
 
Constructor Summary
Reminder()
          Creates a new empty and inactive instance of Reminder
 
Method Summary
 int getInterval()
          Returns the interval between snoozes, in minutes.
 int getMinutes()
          Returns how many minutes before the start of the event or task the reminder should activate.
 int getOptions()
          Returns the extra options.
 int getRepeatCount()
          Returns the number of times that the reminder has still to be repeated.
 java.lang.String getSoundFile()
          Returns the path of the sound file played as a reminder.
 java.lang.String getTime()
          Returns the date and time when the reminder is going to be activated.
 boolean isActive()
          Returns whether the reminder is active or switched off.
 void setActive(boolean active)
          Setter for property active.
 void setInterval(int interval)
          Setter for property interval.
 void setMinutes(int minutes)
          Setter for property minutes.
 void setOptions(int options)
          Setter for property options.
 void setRepeatCount(int repeatCount)
          Setter for property repeatCount.
 void setSoundFile(java.lang.String soundFile)
          Setter for property soundFile.
 void setTime(java.lang.String time)
          Setter for property time.
 java.lang.String toString()
           
 
Methods inherited from class com.funambol.common.pim.model.common.PropertyWithTimeZone
getTimeZone, setTimeZone
 
Methods inherited from class com.funambol.common.pim.model.common.Property
compare, equals, getAltrep, getCharset, getCn, getCutype, getDelegatedFrom, getDelegatedTo, getDir, getEncoding, getGroup, getLanguage, getMember, getPartstat, getPropertyValue, getPropertyValueAsString, getRelated, getSentby, getTag, getType, getValue, getXParams, hashCode, isEmptyProperty, setAltrep, setCharset, setCn, setCutype, setDelegatedFrom, setDelegatedTo, setDir, setEncoding, setGroup, setLanguage, setMember, setPartstat, setPropertyValue, setRelated, setSentby, setTag, setType, setValue, setXParams, stringFrom, stringFrom
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Reminder

public Reminder()
Creates a new empty and inactive instance of Reminder

Method Detail

getMinutes

public int getMinutes()
Returns how many minutes before the start of the event or task the reminder should activate.

Returns:
value of property minutes

setMinutes

public void setMinutes(int minutes)
Setter for property minutes. setTime(String) must be used whenever no start date/time is available; if the start date/time is available also this method can be used. NB: Consistence between property minutes and property time cannot be guaranteed.

Parameters:
minutes - new value of property minutes

getTime

public java.lang.String getTime()
Returns the date and time when the reminder is going to be activated.

Returns:
value of property time as a string in ISO-8601 "yyyyMMdd'T'HHmmss'Z'" or "yyyyMMdd'T'HHmmss" format

setTime

public void setTime(java.lang.String time)
Setter for property time. NB: Consistence between property minutes and property time cannot be guaranteed.

Parameters:
time - new value of property time as a string in ISO-8601 "yyyyMMdd'T'HHmmss'Z'" or "yyyyMMdd'T'HHmmss" format

getSoundFile

public java.lang.String getSoundFile()
Returns the path of the sound file played as a reminder.

Returns:
value of property soundFile

setSoundFile

public void setSoundFile(java.lang.String soundFile)
Setter for property soundFile.

Parameters:
soundFile - new value of property soundFile

getOptions

public int getOptions()
Returns the extra options.

Returns:
value of property options

setOptions

public void setOptions(int options)
Setter for property options.

Parameters:
options - new value of property options

isActive

public boolean isActive()
Returns whether the reminder is active or switched off.

Returns:
true only if the reminder is set and active.

setActive

public void setActive(boolean active)
Setter for property active.

Parameters:
active - new value of property active

getInterval

public int getInterval()
Returns the interval between snoozes, in minutes.

Returns:
value of property interval

setInterval

public void setInterval(int interval)
Setter for property interval.

Parameters:
interval - new value of property interval

getRepeatCount

public int getRepeatCount()
Returns the number of times that the reminder has still to be repeated.

Returns:
value of property repeatCount

setRepeatCount

public void setRepeatCount(int repeatCount)
Setter for property repeatCount.

Parameters:
repeatCount - new value of property repeatCount

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2001-2009 Funambol.