oracle.calendar.soap.iCal
Class vAttendee

java.lang.Object
  |
  +--oracle.calendar.soap.iCal.vComponent
        |
        +--oracle.calendar.soap.iCal.vAttendee

public class vAttendee

extends vComponent

The attendee record provides information about one attendee to the instance of an event (either a simple or repeating/recurring). The attendee record follows the IETF iCalendar standard. The Web Services implementation requires that the attendee value be email addresses (either Oracle Internet Directory user's or user's external to the system). The value is always of the for "mailto:xxxxx". The common name attribute provides an X.400 representation of the attendee's name and is typically user for display purposes. However, for external attendees, this information may not be available. The attendee status is provided in the PartStat (participation status) member. The attendee is parented to the vEvent.

See Also:

vEvent

Field Summary

static java.lang.String	k_accepted
static java.lang.String	k_cn
static java.lang.String	k_declined
static java.lang.String	k_needsAction
static java.lang.String	k_partStat
static java.lang.String	k_vAttendee
private java.lang.String	m_cn
private java.lang.String	m_partStat
private java.lang.String	m_value

Constructor Summary

vAttendee()
Default constructor

Method Summary

java.lang.String	getCN() Retrieve the common name of the attendee.
org.w3c.dom.Element	getElement(org.w3c.dom.Document in_document) Returns a new XML DOM structure representing the vAttendee XML tree structure.
java.lang.String	getPartStat() Retrieve the participation status for the status.
java.lang.String	getValue() Retrieve the attendee's email address
void	setCN(java.lang.String in_cn) Assigns the common name of the attendee.
void	setPartStat(java.lang.String in_partStat) Set the participation status for the attendee.
void	setValue(java.lang.String in_emailAddress) Assigns a attendee's email address.
java.lang.String	toString() Constructs a String representing the vAttendee objects and all children.
static vAttendee	unmarshall(org.w3c.dom.Element in_element) Constructs a new vAttendee instance from the XML elements within the XML DOM.

Methods inherited from class java.lang.Object

<clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

k_vAttendee

public static final java.lang.String k_vAttendee

k_cn

public static final java.lang.String k_cn

k_partStat

public static final java.lang.String k_partStat

k_needsAction

public static final java.lang.String k_needsAction

k_declined

public static final java.lang.String k_declined

k_accepted

public static final java.lang.String k_accepted

m_cn

private java.lang.String m_cn

m_value

private java.lang.String m_value

m_partStat

private java.lang.String m_partStat

Constructor Detail

vAttendee

public vAttendee()

Default constructor

Method Detail

getCN

public java.lang.String getCN()

Retrieve the common name of the attendee.

Returns:

String the attendee's common name

setCN

public void setCN(java.lang.String in_cn)

Assigns the common name of the attendee.

Returns:

String the attendee's common name

getPartStat

public java.lang.String getPartStat()

Retrieve the participation status for the status. The string can be ACCEPTED DECLINED NEEDS-ACTION. NOTE: DELEGATED and TENTATIVE are not supported.

Returns:

String the attendee's part stat

setPartStat

public void setPartStat(java.lang.String in_partStat)

Set the participation status for the attendee. It should be noted that the calendar server will only accept a change in partstat if the it's the user's attendee record, no others. Use the predefined constants when updating the value.

Parameters:

String - the attendee's part stat

getValue

public java.lang.String getValue()

Retrieve the attendee's email address

Returns:

String the attendee's email address

setValue

public void setValue(java.lang.String in_emailAddress)

Assigns a attendee's email address. The string MUST be of the form mailto:...

Parameters:

String - the attendee's email address

unmarshall

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

Constructs a new vAttendee instance from the XML elements within the XML DOM.

Parameters:

in_element -

Returns:

vAttendee a vAttendee

getElement

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

Returns a new XML DOM structure representing the vAttendee XML tree structure. This is called internally when a Calendarlet command is being generated to DOM format.

Overrides:

getElement in class vComponent

Returns:

Element an XML DOM element tree

toString

public java.lang.String toString()

Constructs a String representing the vAttendee objects and all children. NOTE: this is not iCalendar 2.0 format.

Overrides:

toString in class vComponent

Returns:

String a serialized vAttendee