oracle.calendar.soap.iCal
Class vAlarm

java.lang.Object
oracle.calendar.soap.iCal.vComponent
oracle.calendar.soap.iCal.vAlarm

public class vAlarm

extends vComponent

Contains information about an alarm. This alarm, for this Web services implementation, is a a reminder of any meeting instance. A vAlarm is always attached to a vEvent object.

Field Summary

static java.lang.String	k_action
static java.lang.String	k_alarmTypeAudio
static java.lang.String	k_alarmTypeDisplay
static java.lang.String	k_alarmTypeEmail
static java.lang.String	k_alarmTypeXOracleDefault
static java.lang.String	k_alarmTypeXOracleNone
static java.lang.String	k_alarmTypeXOracleSMS
static java.lang.String	k_trigger
static java.lang.String	k_vAlarm

Constructor Summary

vAlarm()
Default constructor version 2004-04-07 fix010267

Method Summary

java.lang.String	getAction() Retrieves the type of action to be performed by the alarm.
org.w3c.dom.Element	getElement(org.w3c.dom.Document in_document) Returns a new XML DOM structure representing the vAlarm XML tree structure.
java.lang.String	getTrigger() Retrieves the trigger value of the alarm, the time and duration of the alarm.
void	setAction(java.lang.String in_action) Assigns the type of the action to be performed by the alarm.
void	setTrigger(java.lang.String in_trigger) Assigns the value of the trigger value of the alarm, the time and duration of the alarm.
java.lang.String	toString() Constructs a non-XML String representing the vAlarm objects and all its children.
static vAlarm	unmarshall(org.w3c.dom.Element in_element) Constructs a new vAlarm instance from the XML elements within the XML DOM.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

k_vAlarm

public static final java.lang.String k_vAlarm

See Also:

Constant Field Values

k_action

public static final java.lang.String k_action

See Also:

Constant Field Values

k_trigger

public static final java.lang.String k_trigger

See Also:

Constant Field Values

k_alarmTypeAudio

public static final java.lang.String k_alarmTypeAudio

See Also:

Constant Field Values

k_alarmTypeDisplay

public static final java.lang.String k_alarmTypeDisplay

See Also:

Constant Field Values

k_alarmTypeEmail

public static final java.lang.String k_alarmTypeEmail

See Also:

Constant Field Values

k_alarmTypeXOracleDefault

public static final java.lang.String k_alarmTypeXOracleDefault

See Also:

Constant Field Values

k_alarmTypeXOracleNone

public static final java.lang.String k_alarmTypeXOracleNone

See Also:

Constant Field Values

k_alarmTypeXOracleSMS

public static final java.lang.String k_alarmTypeXOracleSMS

See Also:

Constant Field Values

Constructor Detail

vAlarm

public vAlarm()

Default constructor version 2004-04-07 fix010267

Method Detail

getAction

public java.lang.String getAction()

Retrieves the type of action to be performed by the alarm. This can be one of the following:

• AUDIO
• DISPLAY (displays a popup)
• EMAIL (emails a reminder)
• PRODECURE
• X-ORACLE-ALARM-DEFAULT (uses the user's server's default action)
• X-ORACLE-ALARM-NONE (does not trigger an alarm)
• X-ORACLE-SMS (trigger an SMS)

version 2004-06-08 fix010519

Returns:

String - Action to be performed

setAction

public void setAction(java.lang.String in_action)

Assigns the type of the action to be performed by the alarm. This can be one of the following:

• AUDIO
• DISPLAY (displays a popup)
• EMAIL (emails a reminder)
• PRODECURE
• X-ORACLE-ALARM-DEFAULT (uses the user's server's default action)
• X-ORACLE-ALARM-NONE (does not trigger an alarm)
• X-ORACLE-SMS (trigger an SMS)

version 2004-06-08 fix010519

Parameters:

in_action - an action type

getTrigger

public java.lang.String getTrigger()

Retrieves the trigger value of the alarm, the time and duration of the alarm. version 2004-04-07 fix010267

Returns:

String - Trigger value

setTrigger

public void setTrigger(java.lang.String in_trigger)

Assigns the value of the trigger value of the alarm, the time and duration of the alarm. version 2004-04-07 fix010267

Parameters:

in_trigger - - Trigger value

unmarshall

public static vAlarm unmarshall(org.w3c.dom.Element in_element)

Constructs a new vAlarm instance from the XML elements within the XML DOM. version 2004-06-22 fix010519

Parameters:

in_element - - XML DOM element tree

Returns:

vAlarm - vAlarm instance

getElement

public org.w3c.dom.Element getElement(org.w3c.dom.Document in_document)

Returns a new XML DOM structure representing the vAlarm XML tree structure. This is called internally when a Calendarlet command is being generated to DOM format. version 2004-04-07 fix010267

Overrides:

getElement in class vComponent

Parameters:

in_document -

Returns:

Element - XML DOM element tree

toString

public java.lang.String toString()

Constructs a non-XML String representing the vAlarm objects and all its children. (In general, each line of this string contains an iCalendar property, followed by a colon, then the value of the property.) Note that this string is not IETF iCalendar 2.0 format. version 2004-04-07 fix010267

Overrides:

toString in class vComponent

Returns:

String - Serialized vAlarm