oracle.calendar.soap.iCal
Class vEvent

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

public class vEvent

extends vComponent

Contains information about an event. This event, for this Web services implementation, refers to one meeting or instance of a repeating meeting.

See Also:

vAttendee

Field Summary

static java.lang.String	k_alarm
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_dialinInfo
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_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
static java.lang.String	k_webConferenceAttendeeURL
static java.lang.String	k_webConferenceHostURL
static java.lang.String	k_webConferenceId
static java.lang.String	k_webConferenceIsEnabled
static java.lang.String	k_webConferenceKey
static java.lang.String	k_webConferenceSecType
static java.lang.String	k_webConferenceTypePublic
static java.lang.String	k_webConferenceTypeRegular
static java.lang.String	k_webConferenceTypeRestricted

Constructor Summary

vEvent()
Default constructor version 2002-12-16 fix008343

Method Summary

void	addAttendee(vAttendee in_attendee) Adds a new attendee to the meeting.
void	addvAlarm(vAlarm in_alarm) Add a new alarm 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	getDialinInfo() Retrieves the dial-in info for that event.
java.lang.String	getDtEnd() Retrieves the meeting ending date and time.
java.lang.String	getDtEndValue() Retrieves the data type of the dtend parameter.
java.lang.String	getDtStart() Retrieves the meeting starting date and 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.util.Vector	getvAlarms() Retrieves the list of alarms.
java.lang.String	getWebConferenceAttendeeURL() Retrieves the Web conference attendee URL for that event.
java.lang.String	getWebConferenceHostURL() Retrieves the Web conference host URL for that event.
java.lang.String	getWebConferenceId() Retrieves the Web conference ID (if applicable).
java.lang.String	getWebConferenceKey() Retrieves the Web conference key for that event.
java.lang.String	getWebConferenceType() Retrieves the Web conference type for that event.
java.lang.String	getXEventType() Retrieves the event type of the vEvent.
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 relevance score for the meeting.
boolean	isOwnedByUser() Returns true if the user specificied in the authentication header is the owner of the meeting.
java.lang.Boolean	isWebConferenceEnabled() Determines if this event is a web conference.
void	setDataGuid(java.lang.String in_dataGuid) Specifies the data GUID of the event.
void	setDescription(java.lang.String in_description) Specifies the meeting description.
void	setDialinInfo(java.lang.String in_dialinInfo) Specifies the dial-in info for this event.
void	setDtEnd(java.lang.String in_dtend) Specifies the meeting ending date and time.
void	setDtEndValue(java.lang.String in_dtendValue) Sets the data type of the dtend parameter.
void	setDtStart(java.lang.String in_dtstart) Specifies the meeting starting date and time.
void	setDtStartValue(java.lang.String in_dtstartvalue) Specifies the data type of the dtstart parameter.
void	setDuration(java.lang.String in_duration) Specifies the event duration.
void	setEventClass(java.lang.String in_class) Specifies the class for the event.
void	setLocation(java.lang.String in_location) Specifies the event location.
void	setOrganizer(vOrganizer in_organizer) Specifies the event organizer.
void	setPriority(java.lang.String in_priority) Specifies the priority.
void	setSummary(java.lang.String in_summary) Specifies the event summary (typically the meeting title).
void	setUid(java.lang.String in_uid) Specifies a UID to the meeting.
void	setWebConferenceEnabled(boolean in_flag) Specifies that this event is (or is not) a web conference.
void	setWebConferenceKey(java.lang.String in_webConferenceKey) Specifies the Web conference key for this event.
void	setWebConferenceType(java.lang.String in_webConferenceType) Specifies the Web conference type for this event.
void	setXEventType(java.lang.String in_type) Specifies the event type.
void	setXScore(java.lang.String in_score) Specifies the search relevance score for the meeting.
java.lang.String	toString() Constructs a non-XML String representing the vEvent objects and all its 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

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

Field Detail

k_vEvent

public static final java.lang.String k_vEvent

See Also:

Constant Field Values

k_class

public static final java.lang.String k_class

See Also:

Constant Field Values

k_description

public static final java.lang.String k_description

See Also:

Constant Field Values

k_dtstart

public static final java.lang.String k_dtstart

See Also:

Constant Field Values

k_dtend

public static final java.lang.String k_dtend

See Also:

Constant Field Values

k_duration

public static final java.lang.String k_duration

See Also:

Constant Field Values

k_location

public static final java.lang.String k_location

See Also:

Constant Field Values

k_organizer

public static final java.lang.String k_organizer

See Also:

Constant Field Values

k_priority

public static final java.lang.String k_priority

See Also:

Constant Field Values

k_summary

public static final java.lang.String k_summary

See Also:

Constant Field Values

k_uid

public static final java.lang.String k_uid

See Also:

Constant Field Values

k_attendee

public static final java.lang.String k_attendee

See Also:

Constant Field Values

k_alarm

public static final java.lang.String k_alarm

See Also:

Constant Field Values

k_eventType

public static final java.lang.String k_eventType

See Also:

Constant Field Values

k_score

public static final java.lang.String k_score

See Also:

Constant Field Values

k_eventGuid

public static final java.lang.String k_eventGuid

See Also:

Constant Field Values

k_instGuid

public static final java.lang.String k_instGuid

See Also:

Constant Field Values

k_dataGuid

public static final java.lang.String k_dataGuid

See Also:

Constant Field Values

k_loginUser

public static final java.lang.String k_loginUser

See Also:

Constant Field Values

k_webConferenceIsEnabled

public static final java.lang.String k_webConferenceIsEnabled

See Also:

Constant Field Values

k_dialinInfo

public static final java.lang.String k_dialinInfo

See Also:

Constant Field Values

k_webConferenceId

public static final java.lang.String k_webConferenceId

See Also:

Constant Field Values

k_webConferenceKey

public static final java.lang.String k_webConferenceKey

See Also:

Constant Field Values

k_webConferenceSecType

public static final java.lang.String k_webConferenceSecType

See Also:

Constant Field Values

k_webConferenceHostURL

public static final java.lang.String k_webConferenceHostURL

See Also:

Constant Field Values

k_webConferenceAttendeeURL

public static final java.lang.String k_webConferenceAttendeeURL

See Also:

Constant Field Values

k_webConferenceTypePublic

public static final java.lang.String k_webConferenceTypePublic

See Also:

Constant Field Values

k_webConferenceTypeRegular

public static final java.lang.String k_webConferenceTypeRegular

See Also:

Constant Field Values

k_webConferenceTypeRestricted

public static final java.lang.String k_webConferenceTypeRestricted

See Also:

Constant Field Values

k_value

public static final java.lang.String k_value

See Also:

Constant Field Values

k_cn

public static final java.lang.String k_cn

See Also:

Constant Field Values

k_eventClassPublic

public static final java.lang.String k_eventClassPublic

See Also:

Constant Field Values

k_eventClassPrivate

public static final java.lang.String k_eventClassPrivate

See Also:

Constant Field Values

k_eventClassConfidential

public static final java.lang.String k_eventClassConfidential

See Also:

Constant Field Values

k_priorityHighest

public static final java.lang.String k_priorityHighest

See Also:

Constant Field Values

k_priorityHigh

public static final java.lang.String k_priorityHigh

See Also:

Constant Field Values

k_priorityNormal

public static final java.lang.String k_priorityNormal

See Also:

Constant Field Values

k_priorityLow

public static final java.lang.String k_priorityLow

See Also:

Constant Field Values

k_priorityLowest

public static final java.lang.String k_priorityLowest

See Also:

Constant Field Values

k_eventTypeAppointment

public static final java.lang.String k_eventTypeAppointment

See Also:

Constant Field Values

k_eventTypeDayEvent

public static final java.lang.String k_eventTypeDayEvent

See Also:

Constant Field Values

k_eventTypeDailyNote

public static final java.lang.String k_eventTypeDailyNote

See Also:

Constant Field Values

k_eventTypeHoliday

public static final java.lang.String k_eventTypeHoliday

See Also:

Constant Field Values

k_valueTypeDate

public static final java.lang.String k_valueTypeDate

See Also:

Constant Field Values

k_valueTypeDateTime

public static final java.lang.String k_valueTypeDateTime

See Also:

Constant Field Values

Constructor Detail

vEvent

public vEvent()

Default constructor version 2002-12-16 fix008343

Method Detail

isWebConferenceEnabled

public java.lang.Boolean isWebConferenceEnabled()

Determines if this event is a web conference. version 2005-04-08 fix011678

Returns:

Boolean

setWebConferenceEnabled

public void setWebConferenceEnabled(boolean in_flag)

Specifies that this event is (or is not) a web conference. version 2005-04-08 fix011678

Parameters:

in_flag - boolean

getDialinInfo

public java.lang.String getDialinInfo()

Retrieves the dial-in info for that event. version 2004-04-28 fix010320

Returns:

String - dial-in info

setDialinInfo

public void setDialinInfo(java.lang.String in_dialinInfo)

Specifies the dial-in info for this event. version 2004-04-28 fix010320

Parameters:

in_dialinInfo - String

getWebConferenceId

public java.lang.String getWebConferenceId()

Retrieves the Web conference ID (if applicable). version 2004-04-28 fix010320

Returns:

String - Web coneference ID

getWebConferenceKey

public java.lang.String getWebConferenceKey()

Retrieves the Web conference key for that event. version 2004-04-28 fix010320

Returns:

String - Web conference key

setWebConferenceKey

public void setWebConferenceKey(java.lang.String in_webConferenceKey)

Specifies the Web conference key for this event. version 2004-04-28 fix010320

Parameters:

in_webConferenceKey - String

getWebConferenceType

public java.lang.String getWebConferenceType()

Retrieves the Web conference type for that event. It can be either PUBLIC, REGULAR, or RESTRICTED. version 2004-04-28 fix010320

Returns:

String - Web conference type

setWebConferenceType

public void setWebConferenceType(java.lang.String in_webConferenceType)

Specifies the Web conference type for this event. It can be either PUBLIC, REGULAR, or RESTRICTED. version 2004-04-28 fix010320

Parameters:

in_webConferenceType - String

getWebConferenceHostURL

public java.lang.String getWebConferenceHostURL()

Retrieves the Web conference host URL for that event. version 2004-04-28 fix010320

Returns:

String - Web conference host URL

getWebConferenceAttendeeURL

public java.lang.String getWebConferenceAttendeeURL()

Retrieves the Web conference attendee URL for that event. version 2004-04-28 fix010320

Returns:

String - Web conference attendee URL

getEventClass

public java.lang.String getEventClass()

Retrieves the event class. This can be either PUBLIC, REGULAR, or RESTRICTED. Note: Normal calender events are mapped to PUBLIC. version 2002-12-20 fix008364

Returns:

String - event class

setEventClass

public void setEventClass(java.lang.String in_class)

Specifies the class for the event. This can be It can be either PUBLIC, REGULAR, or RESTRICTED. Note: Normal calender events are mapped to PUBLIC. version 2002-12-20 fix008364

Parameters:

in_class - event class

getUid

public java.lang.String getUid()

Retrieves the UID of the meeting. Note: A meeting UID is only unique to the owner's agenda. version 2002-12-16 fix008343

Returns:

String - 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. version 2003-01-30 fix008476

Returns:

String - meeting data GUID

setDataGuid

public void setDataGuid(java.lang.String in_dataGuid)

Specifies the data GUID of the event. version 2003-03-25 fix008832

Parameters:

in_dataGuid - 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 (which is possibly composed of many instances). version 2003-01-21 fix008443

Returns:

String - 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). version 2003-01-21 fix008443

Returns:

String - instance's CS GUID

setUid

public void setUid(java.lang.String in_uid)

Specifies 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 person's agenda, the creation will fail.

Note: This API may be removed for release.

version 2002-12-20 fix008364

Parameters:

in_uid - 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

• APPOINTMENT - Meetings
• DAY EVENT - Day Events
• DAILY NOTE - Daily Notes
• HOLIDAY - Holidays

version 2002-12-20 fix008364

Returns:

String - event type

setXEventType

public void setXEventType(java.lang.String in_type)

Specifies 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

• APPOINTMENT - Meetings
• DAY EVENT - Day Events
• DAILY NOTE - Daily Notes
• HOLIDAY - Holidays (not permitted)

version 2002-12-20 fix008364

Parameters:

in_type - event type

getPriority

public java.lang.String getPriority()

Retrieves the priority of the vEvent.

The possible values are

• 1 - Highest
• 2 - High
• 5 - Normal
• 7 - Low
• 9 - Lowest

version 2003-03-17 fix008832

Returns:

String - priority value

setPriority

public void setPriority(java.lang.String in_priority)

Specifies the priority. The following constants are provided to ensure proper mapping with the Calender client.

The possible values are

• 1 - Highest
• 2 - High
• 5 - Normal
• 7 - Low
• 9 - Lowest

version 2003-03-17 fix008832

Parameters:

in_priority - priority value

getDescription

public java.lang.String getDescription()

Retrieves the meeting description (typically the meeting details). version 2002-12-16 fix008343

Returns:

String - event description

setDescription

public void setDescription(java.lang.String in_description)

Specifies the meeting description. version 2002-12-20 fix008364

Parameters:

in_description - event description

getDtStart

public java.lang.String getDtStart()

Retrieves the meeting starting date and time. The date and 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. version 2003-01-17 fix008443

Returns:

String - event start UTC DATE-TIME or DATE value

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.

version 2003-01-17 fix008443

Returns:

String - "DATE-TIME" or "DATE"

setDtStart

public void setDtStart(java.lang.String in_dtstart)

Specifies the meeting starting date and time. The date and 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. version 2003-01-17 fix008443

Parameters:

in_dtstart - UTC DATE-TIME or DATE value

setDtStartValue

public void setDtStartValue(java.lang.String in_dtstartvalue)

Specifies the data type of the dtstart parameter. For a dtstart with time and date information, specify the string "DATE-TIME" or k_valueTypeDateTime. This is the default interpretation, if none is set.

For a dtstart with date information only, specify the string "DATE" or k_valueTypeDate.

version 2003-01-17 fix008443

Parameters:

in_dtstartvalue - "DATE-TIME" or "DATE"

getDtEnd

public java.lang.String getDtEnd()

Retrieves the meeting ending date and time. The date and time is a UTC string of the form yyyymmddThhmmssZ. version 2003-01-16 fix008443

Returns:

String - event ending UTC DATE-TIME value

getDtEndValue

public java.lang.String getDtEndValue()

Retrieves the data type of the dtend 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.

version 2003-01-17 fix008443

Returns:

String - "DATE-TIME" or "DATE"

setDtEnd

public void setDtEnd(java.lang.String in_dtend)

Specifies the meeting ending date and time. The date and time is a UTC string of the form yyyymmddThmmss. version 2003-03-19 fix008832

Parameters:

in_dtend - event ending UTC DATE-TIME value

setDtEndValue

public void setDtEndValue(java.lang.String in_dtendValue)

Sets the data type of the dtend parameter. For a dtend with time and date information, the value will be the string "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 the stirng "DATE" or k_valueTypeDate.

version 2003-03-21 fix008832

Parameters:

in_dtendValue - "DATE-TIME" or "DATE"

getDuration

public java.lang.String getDuration()

Retrieves the event duration. The duration string is of the form PThhHmmM. version 2002-12-20 fix008364

Returns:

String - event duration string

setDuration

public void setDuration(java.lang.String in_duration)

Specifies the event duration. The duration string is of the form PThhHmmM version 2002-12-20 fix008364

Parameters:

in_duration - event duration string

getLocation

public java.lang.String getLocation()

Retrieves the event location. version 2002-12-16 fix008343

Returns:

String - event location

setLocation

public void setLocation(java.lang.String in_location)

Specifies the event location. version 2002-12-20 fix008343

Returns:

String - event location

getOrganizer

public vOrganizer getOrganizer()

Retrieves the event organizer. version 2002-12-19 fix008364

Returns:

vOrganizer - event organizer

setOrganizer

public void setOrganizer(vOrganizer in_organizer)

Specifies the event organizer. version 2003-03-21 fix008832

Parameters:

in_organizer - event organizer

getSummary

public java.lang.String getSummary()

Retrieves the event summary. This is typically the meeting title. version 2002-12-16 fix008343

Returns:

String - event summary

setSummary

public void setSummary(java.lang.String in_summary)

Specifies the event summary (typically the meeting title). version 2002-12-20 fix008364

Parameters:

in_summary - event summary

getXLoginUser

public java.lang.String getXLoginUser()

Retrieves the login user's email address. version 2003-05-24 fix009294

Returns:

String - login user's email address

getXLoginUserCN

public java.lang.String getXLoginUserCN()

Retrieves the login user's common name. version 2003-05-24 fix009294

Returns:

String - login user's common name

getXScore

public java.lang.String getXScore()

Retrieves the search relevance score for the meeting. Represents the relative weight of this instance in the Ultra Search result set. This property contains a value between 0 and 100. Instances with higher values are considered more likely to be relevant to the end user. This will only be available if the Search was performed with a <Search> element. This is only to be used for Ultra Search. version 2002-12-16 fix008343

Returns:

String - event's search relevance score

setXScore

public void setXScore(java.lang.String in_score)

Specifies the search relevance score for the meeting. Represents the relative weight of this instance in the Ultra Search result set. This property contains a value between 0 and 100. Instances with higher values are considered more likely to be relevant to the end user. This will only be available if the Search was performed with a <Search> element. This is only to be used for Ultra Search. * version 2003-03-19 fix008832

Parameters:

in_score - event's search relevance score

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. version 2003-05-26 fix009294

Returns:

boolean

getAttendees

public java.util.Vector getAttendees()

Retrieves the list of attendees. version 2002-12-16 fix008343

Returns:

Vector - Vector of vAttendee

See Also:

vAttendee

addAttendee

public void addAttendee(vAttendee in_attendee)

Adds a new attendee to the meeting. version 2002-12-19 fix008364

Parameters:

in_attendee - - new attendee

See Also:

vAttendee

getUserAttendeeObject

public vAttendee getUserAttendeeObject()

Retrieves the attendee object for the logged in user. version 2004-06-17 fix10502

Returns:

vAttendee - logged in user

See Also:

vAttendee

getvAlarms

public java.util.Vector getvAlarms()

Retrieves the list of alarms. version 2004-04-07 fix010267

Returns:

Vector - Vector of vAlarm

See Also:

vAlarm

addvAlarm

public void addvAlarm(vAlarm in_alarm)

Add a new alarm to the meeting. version 2004-04-07 fix010267

Parameters:

in_alarm - new alarm

See Also:

vAlarm

unmarshall

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

Constructs a new vEvent instance from the XML elements within the XML DOM. version 2005-04-08 fix011678

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. version 2005-04-08 fix011678

Overrides:

getElement in class vComponent

Returns:

Element - XML DOM element tree

toString

public java.lang.String toString()

Constructs a non-XML String representing the vEvent 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: This string is not IETF iCalendar 2.0 format. * version 2005-04-08 fix011678

Overrides:

toString in class vComponent

Returns:

String - serialized vEvent