oracle.calendar.soap.iCal
Class vEvent

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

public class vEvent

extends vComponent

The vEvent mirrors the IETF definition of a vEvent. The component contains information about an event. This event, for the current Web Services implementation, refers to one meeting or instance of a repeating meeting. In the grandeur scheme of things, a vEvent can also represent multiple meetings, a recurring meeting.

See Also:

vAttendee

Field Summary

static java.lang.String	k_attendee
static java.lang.String	k_class
static java.lang.String	k_cn
static java.lang.String	k_dataGuid
static java.lang.String	k_description
static java.lang.String	k_dtend
static java.lang.String	k_dtstart
static java.lang.String	k_duration
static java.lang.String	k_eventClassConfidential
static java.lang.String	k_eventClassPrivate
static java.lang.String	k_eventClassPublic
static java.lang.String	k_eventGuid
static java.lang.String	k_eventType
static java.lang.String	k_eventTypeAppointment
static java.lang.String	k_eventTypeDailyNote
static java.lang.String	k_eventTypeDayEvent
static java.lang.String	k_eventTypeHoliday
static java.lang.String	k_iMeetingDetailsUrl
static java.lang.String	k_iMeetingDialinInfo
static java.lang.String	k_iMeetingEnabled
static java.lang.String	k_iMeetingId
static java.lang.String	k_iMeetingPassword
static java.lang.String	k_iMeetingType
static java.lang.String	k_iMeetingTypePublic
static java.lang.String	k_iMeetingTypeRegular
static java.lang.String	k_iMeetingTypeRestricted
static java.lang.String	k_instGuid
static java.lang.String	k_location
static java.lang.String	k_loginUser
static java.lang.String	k_organizer
static java.lang.String	k_priority
static java.lang.String	k_priorityHigh
static java.lang.String	k_priorityHighest
static java.lang.String	k_priorityLow
static java.lang.String	k_priorityLowest
static java.lang.String	k_priorityNormal
static java.lang.String	k_score
static java.lang.String	k_summary
static java.lang.String	k_uid
static java.lang.String	k_value
static java.lang.String	k_valueTypeDate
static java.lang.String	k_valueTypeDateTime
static java.lang.String	k_vEvent
private java.util.Vector	m_attendees
private java.lang.String	m_class
private java.lang.String	m_dataGuid
private java.lang.String	m_description
private java.lang.String	m_dtend
private java.lang.String	m_dtendvalue
private java.lang.String	m_dtstart
private java.lang.String	m_dtstartvalue
private java.lang.String	m_duration
private java.lang.String	m_eventGuid
private java.lang.String	m_eventType
private java.lang.String	m_iMeetingDetailsUrl
private java.lang.String	m_iMeetingDialinInfo
private java.lang.String	m_iMeetingEnabled
private java.lang.String	m_iMeetingId
private java.lang.String	m_iMeetingPassword
private java.lang.String	m_iMeetingType
private java.lang.String	m_instanceGuid
private java.lang.String	m_location
private java.lang.String	m_loginUser
private java.lang.String	m_loginUserCN
private vOrganizer	m_organizer
private java.lang.String	m_priority
private java.lang.String	m_score
private java.lang.String	m_summary
private java.lang.String	m_uid

Constructor Summary

vEvent()
Default constructor

Method Summary

void	addAttendee(vAttendee in_attendee) Add a new attendee to the meeting
java.util.Vector	getAttendees() Retrieves the list of attendees
java.lang.String	getDataGuid() Retrieves the Data GUID of the event.
java.lang.String	getDescription() Retrieves the meeting description (typically the meeting details)
java.lang.String	getDtEnd() Retrieves the meeting end date.
java.lang.String	getDtEndValue() Gets the dtend date or date-time parameter.
java.lang.String	getDtStart() Retrieves the meeting start date-time.
java.lang.String	getDtStartValue() Gets the dtstart date or date-time parameter.
java.lang.String	getDuration() Retrieves the event duration.
org.w3c.dom.Element	getElement(org.w3c.dom.Document in_document) Returns a new XML DOM structure representing the vEvent XML tree structure.
java.lang.String	getEventClass() Retrieves the event class.
java.lang.String	getEventGuid() Retrieves the CS GUID of the event.
java.lang.String	getInstanceGuid() Retrieves the CS GUID of the event instance.
java.lang.String	getLocation() Retrieves the event location
vOrganizer	getOrganizer() Retrieves the event organizer
java.lang.String	getPriority() Retrieves the priority of the vEvent.
java.lang.String	getSummary() Retrieves the event summary.
java.lang.String	getUid() Retrieves the UID of the meeting.
vAttendee	getUserAttendeeObject() Retrieves the attendee object for the logged in user
java.lang.String	getXEventType() Retrieves the event type of the vEvent.
java.lang.String	getXiMeetingDetailsUrl() Retrieves the iMeeting details URL.
java.lang.String	getXiMeetingDialinInfo() Retrieves the iMeeting dialin info.
java.lang.String	getXiMeetingEnabled() Retrieves the iMeeting enabled flag.
java.lang.String	getXiMeetingId() Retrieves the iMeeting ID.
java.lang.String	getXiMeetingPassword() Retrieves the iMeeting password.
java.lang.String	getXiMeetingType() Retrieves the iMeeting type.
java.lang.String	getXLoginUser() Retrieves the login user's email address.
java.lang.String	getXLoginUserCN() Retrieves the login user's common name
java.lang.String	getXScore() Retrieves the search results core for the meeting.
boolean	isOwnedByUser() Returns true if the user specificied in the authentication header is the owner of the meeting.
void	setDataGuid(java.lang.String in_dataGuid) Sets the Data GUID of the event.
void	setDescription(java.lang.String in_description) Set a meeting description (a.k.a.
void	setDtEnd(java.lang.String in_dtend) Sets the meeting end date.
void	setDtEndValue(java.lang.String in_dtendValue) Sets the dtend date or date-time parameter.
void	setDtStart(java.lang.String in_dtstart) Sets the meeting start datetime.
void	setDtStartValue(java.lang.String in_dtstartvalue) Sets the dtstart date or date-time parameter.
void	setDuration(java.lang.String in_duration) Sets the event duration.
void	setEventClass(java.lang.String in_class) Assigns the class for the event.
void	setLocation(java.lang.String in_location) Sets the event location field
void	setOrganizer(vOrganizer in_organizer) Sets the event organizer
void	setPriority(java.lang.String in_priority) Set the priority.
void	setSummary(java.lang.String in_summary) Sets the events summary (typically the meeting title)
void	setUid(java.lang.String in_uid) Assigns a UID to the meeting.
void	setXEventType(java.lang.String in_type) Set the event type.
void	setXiMeetingDialinInfo(java.lang.String in_iMeetingDialinInfo) Sets the iMeeting dialin info.
void	setXiMeetingEnabled(java.lang.String in_iMeetingEnabled) Sets the iMeeting enabled flag.
void	setXiMeetingPassword(java.lang.String in_iMeetingPassword) Sets the iMeeting password.
void	setXiMeetingType(java.lang.String in_iMeetingType) Sets the iMeeting type.
void	setXScore(java.lang.String in_score) Sets the search results core for the meeting.
java.lang.String	toString() Constructs a String representing the vEvent objects and all children.
static vEvent	unmarshall(org.w3c.dom.Element in_element) Constructs a new vEvent instance from the XML elements within the XML DOM.

Methods inherited from class java.lang.Object

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

Field Detail

k_vEvent

public static final java.lang.String k_vEvent

k_class

public static final java.lang.String k_class

k_description

public static final java.lang.String k_description

k_dtstart

public static final java.lang.String k_dtstart

k_dtend

public static final java.lang.String k_dtend

k_duration

public static final java.lang.String k_duration

k_location

public static final java.lang.String k_location

k_organizer

public static final java.lang.String k_organizer

k_priority

public static final java.lang.String k_priority

k_summary

public static final java.lang.String k_summary

k_uid

public static final java.lang.String k_uid

k_attendee

public static final java.lang.String k_attendee

k_eventType

public static final java.lang.String k_eventType

k_score

public static final java.lang.String k_score

k_eventGuid

public static final java.lang.String k_eventGuid

k_instGuid

public static final java.lang.String k_instGuid

k_dataGuid

public static final java.lang.String k_dataGuid

k_loginUser

public static final java.lang.String k_loginUser

k_value

public static final java.lang.String k_value

k_cn

public static final java.lang.String k_cn

k_iMeetingEnabled

public static final java.lang.String k_iMeetingEnabled

k_iMeetingPassword

public static final java.lang.String k_iMeetingPassword

k_iMeetingId

public static final java.lang.String k_iMeetingId

k_iMeetingType

public static final java.lang.String k_iMeetingType

k_iMeetingDialinInfo

public static final java.lang.String k_iMeetingDialinInfo

k_iMeetingDetailsUrl

public static final java.lang.String k_iMeetingDetailsUrl

k_eventClassPublic

public static final java.lang.String k_eventClassPublic

k_eventClassPrivate

public static final java.lang.String k_eventClassPrivate

k_eventClassConfidential

public static final java.lang.String k_eventClassConfidential

k_priorityHighest

public static final java.lang.String k_priorityHighest

k_priorityHigh

public static final java.lang.String k_priorityHigh

k_priorityNormal

public static final java.lang.String k_priorityNormal

k_priorityLow

public static final java.lang.String k_priorityLow

k_priorityLowest

public static final java.lang.String k_priorityLowest

k_eventTypeAppointment

public static final java.lang.String k_eventTypeAppointment

k_eventTypeDayEvent

public static final java.lang.String k_eventTypeDayEvent

k_eventTypeDailyNote

public static final java.lang.String k_eventTypeDailyNote

k_eventTypeHoliday

public static final java.lang.String k_eventTypeHoliday

k_iMeetingTypeRestricted

public static final java.lang.String k_iMeetingTypeRestricted

k_iMeetingTypeRegular

public static final java.lang.String k_iMeetingTypeRegular

k_iMeetingTypePublic

public static final java.lang.String k_iMeetingTypePublic

k_valueTypeDate

public static final java.lang.String k_valueTypeDate

k_valueTypeDateTime

public static final java.lang.String k_valueTypeDateTime

m_class

private java.lang.String m_class

m_eventType

private java.lang.String m_eventType

m_description

private java.lang.String m_description

m_dtstart

private java.lang.String m_dtstart

m_dtstartvalue

private java.lang.String m_dtstartvalue

m_dtend

private java.lang.String m_dtend

m_dtendvalue

private java.lang.String m_dtendvalue

m_duration

private java.lang.String m_duration

m_organizer

private vOrganizer m_organizer

m_priority

private java.lang.String m_priority

m_location

private java.lang.String m_location

m_score

private java.lang.String m_score

m_summary

private java.lang.String m_summary

m_uid

private java.lang.String m_uid

m_dataGuid

private java.lang.String m_dataGuid

m_eventGuid

private java.lang.String m_eventGuid

m_instanceGuid

private java.lang.String m_instanceGuid

m_loginUser

private java.lang.String m_loginUser

m_loginUserCN

private java.lang.String m_loginUserCN

m_attendees

private java.util.Vector m_attendees

m_iMeetingEnabled

private java.lang.String m_iMeetingEnabled

m_iMeetingPassword

private java.lang.String m_iMeetingPassword

m_iMeetingId

private java.lang.String m_iMeetingId

m_iMeetingType

private java.lang.String m_iMeetingType

m_iMeetingDialinInfo

private java.lang.String m_iMeetingDialinInfo

m_iMeetingDetailsUrl

private java.lang.String m_iMeetingDetailsUrl

Constructor Detail

vEvent

public vEvent()

Default constructor

Method Detail

getEventClass

public java.lang.String getEventClass()

Retrieves the event class. This can be

PUBLIC

PRIVATE

CONFIDENTIAL NOTE: Normal calender events are mapped to PUBLIC

Returns:

String the meeting class

setEventClass

public void setEventClass(java.lang.String in_class)

Assigns the class for the event. This can be

PUBLIC

PRIVATE

CONFIDENTIAL NOTE: Normal calender events are mapped to PUBLIC

Parameters:

in_class - an event class

getUid

public java.lang.String getUid()

Retrieves the UID of the meeting. It is important to note that a meeting UID is only unique to the owner's agenda.

Returns:

String the meeting UID

getDataGuid

public java.lang.String getDataGuid()

Retrieves the Data GUID of the event. This GUID can be reused to search by data GUID

Returns:

String the meeting Data GUID

setDataGuid

public void setDataGuid(java.lang.String in_dataGuid)

Sets the Data GUID of the event.

Parameters:

String - the meeting Data GUID

getEventGuid

public java.lang.String getEventGuid()

Retrieves the CS GUID of the event. This GUID can be reused to uniquely identify the vCalendar object (possibly composed of many instances).

Returns:

String the meeting CS GUID

getInstanceGuid

public java.lang.String getInstanceGuid()

Retrieves the CS GUID of the event instance. This GUID can be reused to uniquely identify the vCalendar vEvent instance, within a more complex vCalendar. This value is typically stored in the Data GUID (but will change in future implementations).

Returns:

String the instances CS GUID

setUid

public void setUid(java.lang.String in_uid)

Assigns a UID to the meeting. The UID of a meeting can be set during creation; if a meeting already exists with this UID in the persons agenda, the creation will fail. Changing the UID of an existing meeting is a little bit more dramatic. NOTE: this API may be removed for release.

Parameters:

in_uid - a new UID

getXEventType

public java.lang.String getXEventType()

Retrieves the event type of the vEvent. This is an Oracle extension used to help easily identify the different types of event stored on the calendar server. The possible values are

Meetings - APPOINTMENT

Day Events - DAY EVENT

Daily Notes - DAILY NOTE

Holidays - HOLIDAY

Returns:

String an event type

setXEventType

public void setXEventType(java.lang.String in_type)

Set the event type. This is an Oracle extension used to help easily identify the different types of events stored on the calendar server. The possible values are

Meetings - APPOINTMENT

Day Events - DAY EVENT

Daily Notes - DAILY NOTE

Holidays - HOLIDAY (not permitted)

Parameters:

String - an event type

getPriority

public java.lang.String getPriority()

Retrieves the priority of the vEvent. The possible values are

Highest - 1

High - 2

Normal - 5

Low - 7

Lowest - 9

Returns:

String a priority

setPriority

public void setPriority(java.lang.String in_priority)

Set the priority. The following constants are provided to ensure proper mapping with the calender client. The possible values are

Highest - 1

High - 2

Normal - 5

Low - 7

Lowest - 9

Parameters:

String - a priority code

getDescription

public java.lang.String getDescription()

Retrieves the meeting description (typically the meeting details)

Returns:

String an event description

setDescription

public void setDescription(java.lang.String in_description)

Set a meeting description (a.k.a. the meeting details)

Parameters:

in_description - an event description

getDtStart

public java.lang.String getDtStart()

Retrieves the meeting start date-time. The date time is a UTC string of the form

yyyymmddThhmmssZ The value may also be a start date. The date is a UTC string of the form

yyyymmdd

Returns:

String an event start date time or date

getDtStartValue

public java.lang.String getDtStartValue()

Gets the dtstart date or date-time parameter. For a dtstart with time and date information, the value will be "DATE-TIME" or k_valueTypeDateTime. This is the default interpretation, if none is set. For a dtstart with date information only, the value will be "DATE" or k_valueTypeDate.

Returns:

String an event start date time value

setDtStart

public void setDtStart(java.lang.String in_dtstart)

Sets the meeting start datetime. The date time must be a UTC string of the form

yyyymmddThhmmssZ For day events or daily notes, the start time of the meeting is a UTC date string of the form

yyyymmdd

Parameters:

String - a UTC date-time or date

setDtStartValue

public void setDtStartValue(java.lang.String in_dtstartvalue)

Sets the dtstart date or date-time parameter. For a dtstart with time and date information, set the value to "DATE-TIME" or k_valueTypeDateTime. This is the default interpretation, if none is set. For a dtstart with date information only, set the value to "DATE" or k_valueTypeDate.

Parameters:

String - a UTC date value parameter

getDtEnd

public java.lang.String getDtEnd()

Retrieves the meeting end date. The date is a UTC string of the form

yyyymmddThhmmssZ

Returns:

String an event end date time

getDtEndValue

public java.lang.String getDtEndValue()

Gets the dtend date or date-time parameter. For a dtend with time and date information, the value will be "DATE-TIME" or k_valueTypeDateTime. This is the default interpretation, if none is set. For a dtend with date information only, the value will be "DATE" or k_valueTypeDate.

Returns:

String an event end date time value

setDtEnd

public void setDtEnd(java.lang.String in_dtend)

Sets the meeting end date. The date is a UTC string of the form

yyyymmddThhmmssZ

Parameters:

String - an event end date time

setDtEndValue

public void setDtEndValue(java.lang.String in_dtendValue)

Sets the dtend date or date-time parameter. For a dtend with time and date information, the value will be "DATE-TIME" or k_valueTypeDateTime. This is the default interpretation, if none is set. For a dtend with date information only, the value will be "DATE" or k_valueTypeDate.

Parameters:

String - an event end date time value

getDuration

public java.lang.String getDuration()

Retrieves the event duration. The duration string is of the form

PThhHmmM

Returns:

String an event duration string

setDuration

public void setDuration(java.lang.String in_duration)

Sets the event duration. The duration string is of the form

PThhHmmM

Parameters:

String - an event duration string

getLocation

public java.lang.String getLocation()

Retrieves the event location

Returns:

String an event location

setLocation

public void setLocation(java.lang.String in_location)

Sets the event location field

Returns:

String an event location

getOrganizer

public vOrganizer getOrganizer()

Retrieves the event organizer

Returns:

vOrganizer an event organizer

setOrganizer

public void setOrganizer(vOrganizer in_organizer)

Sets the event organizer

Parameters:

vOrganizer - an event organizer

getSummary

public java.lang.String getSummary()

Retrieves the event summary. This is typically the meeting title.

Returns:

String an event summary

setSummary

public void setSummary(java.lang.String in_summary)

Sets the events summary (typically the meeting title)

Parameters:

in_summary - an event summary

getXLoginUser

public java.lang.String getXLoginUser()

Retrieves the login user's email address.

Returns:

String a login user email

getXLoginUserCN

public java.lang.String getXLoginUserCN()

Retrieves the login user's common name

Returns:

String a login user common name

getXScore

public java.lang.String getXScore()

Retrieves the search results core for the meeting. This will only be available if the Search was performed with a element. This is only to be used for UltraSearch.

Returns:

String an event score

setXScore

public void setXScore(java.lang.String in_score)

Sets the search results core for the meeting. This will only be available if the Search was performed with a element. This is only to be used for UltraSearch.

Parameters:

String - an event score

getXiMeetingEnabled

public java.lang.String getXiMeetingEnabled()

Retrieves the iMeeting enabled flag. This value will only be available if the iMeeting is enabled, otherwise the String will be null. The possible values are TRUE | FALSE.

Returns:

String an iMeeting enabled

setXiMeetingEnabled

public void setXiMeetingEnabled(java.lang.String in_iMeetingEnabled)

Sets the iMeeting enabled flag. The possible values are TRUE | FALSE and can only be set for creation. Modification of this attribute will fail.

Parameters:

in_iMeetingEnabled - an iMeeting enabled flag

getXiMeetingId

public java.lang.String getXiMeetingId()

Retrieves the iMeeting ID. This value will only be available if the iMeeting is enabled, otherwise the String will be null.

Returns:

String an iMeeting Id

getXiMeetingPassword

public java.lang.String getXiMeetingPassword()

Retrieves the iMeeting password. This value will only be available if the iMeeting is enabled, otherwise the String will be null.

Returns:

String an iMeeting password

setXiMeetingPassword

public void setXiMeetingPassword(java.lang.String in_iMeetingPassword)

Sets the iMeeting password.

Parameters:

in_iMeetingPassword - an iMeeting password

getXiMeetingType

public java.lang.String getXiMeetingType()

Retrieves the iMeeting type. This value will only be available if the iMeeting is enabled, otherwise the String will be null. The possible values are

RESTRICTED

REGULAR

PUBLIC

Returns:

String an iMeeting type

setXiMeetingType

public void setXiMeetingType(java.lang.String in_iMeetingType)

Sets the iMeeting type. The possible values are

RESTRICTED

REGULAR

PUBLIC

Parameters:

in_iMeetingPassword - an iMeeting password

getXiMeetingDialinInfo

public java.lang.String getXiMeetingDialinInfo()

Retrieves the iMeeting dialin info. This value will only be available if the iMeeting is enabled, otherwise the String will be null.

Returns:

String an iMeeting dialin info

setXiMeetingDialinInfo

public void setXiMeetingDialinInfo(java.lang.String in_iMeetingDialinInfo)

Sets the iMeeting dialin info.

Parameters:

in_iMeetingDialinInfo - an iMeeting dialin info

getXiMeetingDetailsUrl

public java.lang.String getXiMeetingDetailsUrl()

Retrieves the iMeeting details URL. This value will only be available if the iMeeting is enabled, otherwise the String will be null.

Returns:

String an iMeeting details url

isOwnedByUser

public boolean isOwnedByUser()

Returns true if the user specificied in the authentication header is the owner of the meeting. This information is retrieved from the login user element.

Returns:

boolean returns true false flag

getAttendees

public java.util.Vector getAttendees()

Retrieves the list of attendees

Returns:

Vector a Vector of vAttendee

See Also:

vAttendee

addAttendee

public void addAttendee(vAttendee in_attendee)

Add a new attendee to the meeting

Parameters:

a - new attendee

See Also:

vAttendee

getUserAttendeeObject

public vAttendee getUserAttendeeObject()

Retrieves the attendee object for the logged in user

Returns:

vAttendee

See Also:

vAttendee

unmarshall

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

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

Parameters:

in_element -

getElement

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

Returns a new XML DOM structure representing the vEvent 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 vEvent objects and all children. NOTE: this is not iCalendar 2.0 format.

Overrides:

toString in class vComponent

Returns:

String a serialized vEvent