biweekly.property

Class ProcedureAlarm

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.VCalAlarmProperty

biweekly.property.ProcedureAlarm

public class ProcedureAlarm
extends VCalAlarmProperty

Defines an alarm that executes a procedure when triggered. It is recommended that the VAlarm component be used to created alarms.

Author:

Michael Angstadt

See Also:

vCal 1.0 p.33, VAlarm.procedure(biweekly.property.Trigger, java.lang.String)

Field Summary

Fields inherited from class biweekly.property.VCalAlarmProperty

repeat, snooze, start

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
ProcedureAlarm(String path)

Method Summary

Methods

Modifier and Type	Method and Description
String	getPath() Gets the path or name of the procedure to run when the alarm is triggered.
void	getPath(String path) Sets the path or name of the procedure to run when the alarm is triggered.

Methods inherited from class biweekly.property.VCalAlarmProperty

getRepeat, getSnooze, getStart, setRepeat, setSnooze, setStart

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcedureAlarm

public ProcedureAlarm(String path)

Parameters:

path - the path or name of the procedure to run when the alarm is triggered

Method Detail

getPath

public String getPath()

Gets the path or name of the procedure to run when the alarm is triggered.

Returns:

the path

getPath

public void getPath(String path)

Sets the path or name of the procedure to run when the alarm is triggered.

Parameters:

path - the path