oracle.calendar.soap.iCal
Class vAttendee

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

public class vAttendee

extends vComponent

Provides information about one attendee of an instance of an event. This Web services implementation requires that the attendee value be an email address (either the Oracle Internet Directory user's or user's external to the system). The value is always of the form mailto:attendee.name@my-company.com.

The common name (cn) attribute provides an X.400 representation of the attendee's name and is typically used for display purposes. However, for external attendees, this information may not be available. The attendee status is provided in the PartStat (participation status) property.

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_personalNote
static java.lang.String	k_vAttendee

Constructor Summary

vAttendee()
Default constructor version 2002-12-20 fix008364

Method Summary

java.lang.String	getCN() Retrieves 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() Retrieves the attendee's participation status.
java.lang.String	getPersnonalNote() Retrieves the personal notes of the attendee.
java.lang.String	getValue() Retrieve's 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) Sets the participation status for the attendee.
void	setValue(java.lang.String in_emailAddress) Assigns the attendee's email address.
java.lang.String	toString() Constructs a non-XML String representing the vAttendee objects and all its 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

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

Field Detail

k_vAttendee

public static final java.lang.String k_vAttendee

See Also:

Constant Field Values

k_cn

public static final java.lang.String k_cn

See Also:

Constant Field Values

k_partStat

public static final java.lang.String k_partStat

See Also:

Constant Field Values

k_personalNote

public static final java.lang.String k_personalNote

See Also:

Constant Field Values

k_needsAction

public static final java.lang.String k_needsAction

See Also:

Constant Field Values

k_declined

public static final java.lang.String k_declined

See Also:

Constant Field Values

k_accepted

public static final java.lang.String k_accepted

See Also:

Constant Field Values

Constructor Detail

vAttendee

public vAttendee()

Default constructor version 2002-12-20 fix008364

Method Detail

getCN

public java.lang.String getCN()

Retrieves the common name of the attendee. version 2002-12-16 fix008343

Returns:

String - attendee's common name

setCN

public void setCN(java.lang.String in_cn)

Assigns the common name of the attendee. version 2003-05-24 fix009294

Returns:

String - attendee's common name

getPartStat

public java.lang.String getPartStat()

Retrieves the attendee's participation status. The string can be either ACCEPTED, DECLINED, or NEEDS-ACTION. Note that DELEGATED and TENTATIVE are not supported. version 2002-12-16 fix008343

Returns:

String - attendee's participation status

setPartStat

public void setPartStat(java.lang.String in_partStat)

Sets the participation status for the attendee. In order for the Calendar server to accept a change to partstat, the attendee must be logged in. Use the predefined constants when updating the value (ACCEPTED, DECLINED, or NEEDS-ACTION). version 2002-12-19 fix008364

Parameters:

in_partStat - - attendee's participation status

getValue

public java.lang.String getValue()

Retrieve's the attendee's email address. version 2002-12-16 fix008343

Returns:

String - attendee's email address

setValue

public void setValue(java.lang.String in_emailAddress)

Assigns the attendee's email address. The string must be of the form mailto:attendee.name@my-company.com. version 2002-12-19 fix008364

Parameters:

in_emailAddress - - attendee's email address

getPersnonalNote

public java.lang.String getPersnonalNote()

Retrieves the personal notes of the attendee. version 2004-05-13 fix010403

Returns:

String - attendee's persnonal notes

unmarshall

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

Constructs a new vAttendee instance from the XML elements within the XML DOM. version 2004-05-13 fix010403

Parameters:

in_element - - XML element

Returns:

vAttendee - vAttendee object

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 generated to DOM format. version 2004-05-13 fix010403

Overrides:

getElement in class vComponent

Returns:

Element - XML DOM element tree

toString

public java.lang.String toString()

Constructs a non-XML String representing the vAttendee 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-05-13 fix010403

Overrides:

toString in class vComponent

Returns:

String - serialized vAttendee