com.funambol.common.pim.icalendar
Class VAlarm

java.lang.Object
  extended by com.funambol.common.pim.icalendar.VAlarm

public class VAlarm
extends java.lang.Object

This class represents a VAlarm object which handles only trigger information Once you've set the correct absolute/relative trigger time and the trigger related time (start/end time), you can get the alarm interval in milliseconds


Constructor Summary
VAlarm()
           
 
Method Summary
 long getAlarmInterval()
          Get the alarm interval in milliseconds
 java.lang.String getTriggerAbsoluteTime()
          Get the alarm trigger absolute time
 boolean setAlarmInterval(long interval)
          Set the alarm interval in milliseconds.
 void setCalEndAbsoluteTime(long time)
          Set the related end absolute time
 void setCalStartAbsoluteTime(long time)
          Set the related start absolute time
 void setTriggerAbsoluteTime(long time)
          Set the alarm trigger absolute time.
 void setTriggerAbsoluteTime(java.lang.String time)
          Set the alarm trigger absolute time.
 void setTriggerRelated(java.lang.String related)
          Set the alarm related property: START or END
 void setTriggerRelativeTime(java.lang.String time)
          Set the alarm trigger relative time (the interval).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VAlarm

public VAlarm()
Method Detail

setTriggerAbsoluteTime

public void setTriggerAbsoluteTime(java.lang.String time)
Set the alarm trigger absolute time.

Parameters:
time - the alarm absolute time in String format.

setTriggerAbsoluteTime

public void setTriggerAbsoluteTime(long time)
Set the alarm trigger absolute time.

Parameters:
time - the alarm absolute time in milliseconds.

getTriggerAbsoluteTime

public java.lang.String getTriggerAbsoluteTime()
Get the alarm trigger absolute time

Returns:
the alarm absolute time in String format

setTriggerRelativeTime

public void setTriggerRelativeTime(java.lang.String time)
                            throws ParseException
Set the alarm trigger relative time (the interval). Up to now it's not supported yet.

Parameters:
time - the relative time in String ISO 8601 format
Throws:
ParseException

setCalStartAbsoluteTime

public void setCalStartAbsoluteTime(long time)
Set the related start absolute time

Parameters:
time - the absolute time in milliseconds

setCalEndAbsoluteTime

public void setCalEndAbsoluteTime(long time)
Set the related end absolute time

Parameters:
time - the absolute time

setTriggerRelated

public void setTriggerRelated(java.lang.String related)
Set the alarm related property: START or END

Parameters:
related - the related property

getAlarmInterval

public long getAlarmInterval()
Get the alarm interval in milliseconds

Returns:
the alarm interval in milliseconds

setAlarmInterval

public boolean setAlarmInterval(long interval)
Set the alarm interval in milliseconds.

Parameters:
interval - the alarm interval in milliseconds
Returns:
true if the interval is successfully updated


Copyright © 2001-2009 Funambol.