oracle.panama.messaging.common
Class EventTodoProperties

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--oracle.panama.messaging.common.EventTodoProperties

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

public class EventTodoProperties

extends java.util.Hashtable

This class is used to create a vCalendar's EVENT or TODO entity. EVENT or TODO entity created using this class can be attached to the vCalendar by calling the methods setEvent ot setTodo of class VCalendar.

Author:

vbarmola

See Also:

Serialized Form

Field Summary

static java.lang.String	CATG_APPOINTMENT Category for an event/todo: Indicates an category of type APPOINTMENT
static java.lang.String	CATG_BUSINESS Category for an event/todo: Indicates an category of type BUSINESS
static java.lang.String	CATG_EDUCATION Category for an event/todo: Indicates an category of type EDUCATION
static java.lang.String	CATG_HOLIDAY Category for an event/todo: Indicates an category of type HOLIDAY
static java.lang.String	CATG_MEETING Category for an event/todo: Indicates an category of type MEETING
static java.lang.String	CATG_MISCELLANEOUS Category for an event/todo: Indicates an category of type MISCELLANEOUS
static java.lang.String	CATG_PERSONAL Category for an event/todo: Indicates an category of type PERSONAL
static java.lang.String	CATG_PHONECALL Category for an event/todo: Indicates an category of type PHONE CALL
static java.lang.String	CATG_SICKDAY Category for an event/todo: Indicates an category of type SICK DAY
static java.lang.String	CATG_SPECIALOCC Category for an event/todo: Indicates an category of type SPECIAL OCCASION
static java.lang.String	CATG_TRAVEL Category for an event/todo: Indicates an category of type TRAVEL
static java.lang.String	CATG_VACATION Category for an event/todo: Indicates an category of type VACATION
static java.lang.String	CLASS_CONFIDENTIAL Access Classification : Indicates a CONFIDENTIAL classification
static java.lang.String	CLASS_PRIVATE Access Classification : Indicates a PRIVATE classification
static java.lang.String	CLASS_PUBLIC Access Classification : Indicates a PUBLIC classification
static java.lang.String	EXPECT_FYI Attendee expect property: Indicate a expect property of FYI for an antendee
static java.lang.String	EXPECT_IMMEDIATE Attendee expect property: Indicate a expect property of IMMEDIATE for an antendee
static java.lang.String	EXPECT_REQUEST Attendee expect property: Indicate a expect property of REQUEST for an antendee
static java.lang.String	EXPECT_REQUIRE Attendee expect property: Indicate a expect property of REQUIRE for an antendee
static java.lang.String	ROLE_ATTENDEE Attendee role: Indicate a role ATTENDEE for an antendee
static java.lang.String	ROLE_DELEGATE Attendee role: Indicate a role DELEGATE for an antendee
static java.lang.String	ROLE_ORGANIZER Attendee role: Indicate a role ORGANIZER for an antendee
static java.lang.String	ROLE_OWNER Attendee role: Indicate a role OWNER for an antendee
static java.lang.String	RSVPNO Attendee rsvp property: Indicate a rsvp property of NO for an antendee
static java.lang.String	RSVPYES Attendee rsvp property: Indicate a rsvp property of YES for an antendee
static java.lang.String	STATUS_ACCEPTED Attendee status: Indicate a status ACCEPTED for an antendee
static java.lang.String	STATUS_COMPLETED Attendee status: Indicate a status COMPLETED for an antendee
static java.lang.String	STATUS_CONFIRMED Attendee status: Indicate a status CONFIRMED for an antendee
static java.lang.String	STATUS_DECLINED Attendee status: Indicate a status DECLINED for an antendee
static java.lang.String	STATUS_DELEGATED Attendee status: Indicate a status DELEGATED for an antendee
static java.lang.String	STATUS_NEEDSACTION Attendee status: Indicate a status NEEDS ACTION for an antendee
static java.lang.String	STATUS_SENT Attendee status: Indicate a status SENT for an antendee
static java.lang.String	STATUS_TENTATIVE Attendee status: Indicate a status TENTATIVE for an antendee

Constructor Summary

EventTodoProperties()

Method Summary

void	setAttendee(java.lang.String attendeeName, java.lang.String role, java.lang.String status, java.lang.String rsvp, java.lang.String expect) set an attendee to a group event or todo.
void	setAudioReminder(int month, int date, int year, int hour, int min, int sec, java.lang.String snoozeTime, int repeatCount, java.lang.String audioClip) Set an audio reminder for the entity
void	setCategories(java.lang.String[] cat) Set the Category for the entity.
void	setClassification(java.lang.String classf) Set the access classification for the entity
void	setDateCompleted(int month, int date, int year, int hour, int min, int sec) Set the date and the time that the toodo was actually completed.
void	setDateCreated(int month, int date, int year, int hour, int min, int sec) Set the date and the time that entity was created.
void	setDescription(java.lang.String desc) Set the description of the entity
void	setDisplayReminder(int month, int date, int year, int hour, int min, int sec, java.lang.String snoozeTime, int repeatCount, java.lang.String displayString) Set a display reminder for the entity
void	setDueDate(int month, int date, int year, int hour, int min, int sec) Set date and time what the todo is due to be completed.
void	setEndDate(int month, int date, int year, int hour, int min, int sec) Set the date and time that the event will end.
void	setLocation(java.lang.String loc) set the intended location for the entity
void	setMailReminder(int month, int date, int year, int hour, int min, int sec, java.lang.String snoozeTime, int repeatCount, java.lang.String emailAddress, java.lang.String note) Set the email address tht is to be sent a reminder for the entity.
void	setNumberRecurrences(int rec) Set the number of times the entity will reoccur
void	setPriority(int priority) Set the priority of the entity.
void	setRecurrenceDate(int month, int date, int year, int hour, int min, int sec) Set the recurring date/times of the entity.
void	setRecurrenceRule(java.lang.String rule) Set the rule or repeating pattern for a recurring entity
void	setStartDate(int month, int date, int year, int hour, int min, int sec) Set the date and time that the event will start
void	setStatus(java.lang.String status) Set the status associated with the entity.
void	setSummary(java.lang.String summary) Set a shory summary or subjct of the entity.

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROLE_ATTENDEE

public static final java.lang.String ROLE_ATTENDEE

Attendee role: Indicate a role ATTENDEE for an antendee

See Also:

Constant Field Values

ROLE_ORGANIZER

public static final java.lang.String ROLE_ORGANIZER

Attendee role: Indicate a role ORGANIZER for an antendee

See Also:

Constant Field Values

ROLE_OWNER

public static final java.lang.String ROLE_OWNER

Attendee role: Indicate a role OWNER for an antendee

See Also:

Constant Field Values

ROLE_DELEGATE

public static final java.lang.String ROLE_DELEGATE

Attendee role: Indicate a role DELEGATE for an antendee

See Also:

Constant Field Values

STATUS_ACCEPTED

public static final java.lang.String STATUS_ACCEPTED

Attendee status: Indicate a status ACCEPTED for an antendee

See Also:

Constant Field Values

STATUS_NEEDSACTION

public static final java.lang.String STATUS_NEEDSACTION

Attendee status: Indicate a status NEEDS ACTION for an antendee

See Also:

Constant Field Values

STATUS_SENT

public static final java.lang.String STATUS_SENT

Attendee status: Indicate a status SENT for an antendee

See Also:

Constant Field Values

STATUS_TENTATIVE

public static final java.lang.String STATUS_TENTATIVE

Attendee status: Indicate a status TENTATIVE for an antendee

See Also:

Constant Field Values

STATUS_CONFIRMED

public static final java.lang.String STATUS_CONFIRMED

Attendee status: Indicate a status CONFIRMED for an antendee

See Also:

Constant Field Values

STATUS_DECLINED

public static final java.lang.String STATUS_DECLINED

Attendee status: Indicate a status DECLINED for an antendee

See Also:

Constant Field Values

STATUS_COMPLETED

public static final java.lang.String STATUS_COMPLETED

Attendee status: Indicate a status COMPLETED for an antendee

See Also:

Constant Field Values

STATUS_DELEGATED

public static final java.lang.String STATUS_DELEGATED

Attendee status: Indicate a status DELEGATED for an antendee

See Also:

Constant Field Values

RSVPYES

public static final java.lang.String RSVPYES

Attendee rsvp property: Indicate a rsvp property of YES for an antendee

See Also:

Constant Field Values

RSVPNO

public static final java.lang.String RSVPNO

Attendee rsvp property: Indicate a rsvp property of NO for an antendee

See Also:

Constant Field Values

EXPECT_FYI

public static final java.lang.String EXPECT_FYI

Attendee expect property: Indicate a expect property of FYI for an antendee

See Also:

Constant Field Values

EXPECT_REQUIRE

public static final java.lang.String EXPECT_REQUIRE

Attendee expect property: Indicate a expect property of REQUIRE for an antendee

See Also:

Constant Field Values

EXPECT_REQUEST

public static final java.lang.String EXPECT_REQUEST

Attendee expect property: Indicate a expect property of REQUEST for an antendee

See Also:

Constant Field Values

EXPECT_IMMEDIATE

public static final java.lang.String EXPECT_IMMEDIATE

Attendee expect property: Indicate a expect property of IMMEDIATE for an antendee

See Also:

Constant Field Values

CATG_APPOINTMENT

public static final java.lang.String CATG_APPOINTMENT

Category for an event/todo: Indicates an category of type APPOINTMENT

See Also:

Constant Field Values

CATG_BUSINESS

public static final java.lang.String CATG_BUSINESS

Category for an event/todo: Indicates an category of type BUSINESS

See Also:

Constant Field Values

CATG_EDUCATION

public static final java.lang.String CATG_EDUCATION

Category for an event/todo: Indicates an category of type EDUCATION

See Also:

Constant Field Values

CATG_HOLIDAY

public static final java.lang.String CATG_HOLIDAY

Category for an event/todo: Indicates an category of type HOLIDAY

See Also:

Constant Field Values

CATG_MEETING

public static final java.lang.String CATG_MEETING

Category for an event/todo: Indicates an category of type MEETING

See Also:

Constant Field Values

CATG_MISCELLANEOUS

public static final java.lang.String CATG_MISCELLANEOUS

Category for an event/todo: Indicates an category of type MISCELLANEOUS

See Also:

Constant Field Values

CATG_PERSONAL

public static final java.lang.String CATG_PERSONAL

Category for an event/todo: Indicates an category of type PERSONAL

See Also:

Constant Field Values

CATG_PHONECALL

public static final java.lang.String CATG_PHONECALL

Category for an event/todo: Indicates an category of type PHONE CALL

See Also:

Constant Field Values

CATG_SICKDAY

public static final java.lang.String CATG_SICKDAY

Category for an event/todo: Indicates an category of type SICK DAY

See Also:

Constant Field Values

CATG_SPECIALOCC

public static final java.lang.String CATG_SPECIALOCC

Category for an event/todo: Indicates an category of type SPECIAL OCCASION

See Also:

Constant Field Values

CATG_TRAVEL

public static final java.lang.String CATG_TRAVEL

Category for an event/todo: Indicates an category of type TRAVEL

See Also:

Constant Field Values

CATG_VACATION

public static final java.lang.String CATG_VACATION

Category for an event/todo: Indicates an category of type VACATION

See Also:

Constant Field Values

CLASS_PUBLIC

public static final java.lang.String CLASS_PUBLIC

Access Classification : Indicates a PUBLIC classification

See Also:

Constant Field Values

CLASS_PRIVATE

public static final java.lang.String CLASS_PRIVATE

Access Classification : Indicates a PRIVATE classification

See Also:

Constant Field Values

CLASS_CONFIDENTIAL

public static final java.lang.String CLASS_CONFIDENTIAL

Access Classification : Indicates a CONFIDENTIAL classification

See Also:

Constant Field Values

Constructor Detail

EventTodoProperties

public EventTodoProperties()

Method Detail

setAttendee

public void setAttendee(java.lang.String attendeeName,
                        java.lang.String role,
                        java.lang.String status,
                        java.lang.String rsvp,
                        java.lang.String expect)

set an attendee to a group event or todo. Multiple attendees can be specified by calling this method for every attendees.

Parameters:

attendeeName -

role - role of the attendee. Can be any of the attendee roles defined in the class.

status - status of the attendee. Can be any of the attendee status defined in the class.

rsvp - indicates if the favor of the reply is requested. Can be any of the attendee rsvp defined in the class.

expect - indicates the expectation of the attendee's participation. Can be any of the attendee expect defined in the class.

setCategories

public void setCategories(java.lang.String[] cat)

Set the Category for the entity.

Parameters:

cat - an array containing the valid Category name. The valid category names are defined in the class.

setClassification

public void setClassification(java.lang.String classf)

Set the access classification for the entity

Parameters:

classf - Can contain any of the classification values defined in the class.

setDateCreated

public void setDateCreated(int month,
                           int date,
                           int year,
                           int hour,
                           int min,
                           int sec)

Set the date and the time that entity was created.

setDateCompleted

public void setDateCompleted(int month,
                             int date,
                             int year,
                             int hour,
                             int min,
                             int sec)

Set the date and the time that the toodo was actually completed.

setDescription

public void setDescription(java.lang.String desc)

Set the description of the entity

setDisplayReminder

public void setDisplayReminder(int month,
                               int date,
                               int year,
                               int hour,
                               int min,
                               int sec,
                               java.lang.String snoozeTime,
                               int repeatCount,
                               java.lang.String displayString)

Set a display reminder for the entity

Parameters:

snoozeTime - duration of time after the Run Time that the reminder is to be dormant prior to being repeated. It should be a String conformanting with the ISO 8601 basic representation for the duration of time. Eg "PT15M" (A period of 15 minutes).

repeatCount - The number of times that the reminder is to be repeated.

setAudioReminder

public void setAudioReminder(int month,
                             int date,
                             int year,
                             int hour,
                             int min,
                             int sec,
                             java.lang.String snoozeTime,
                             int repeatCount,
                             java.lang.String audioClip)

Set an audio reminder for the entity

Parameters:

snoozeTime - duration of time after the Run Time that the reminder is to be dormant prior to being repeated. It should be a String conformanting with the ISO 8601 basic representation for the duration of time. Eg "PT15M" (A period of 15 minutes).

repeatCount - The number of times that the reminder is to be repeated.

audioClip - digital sound to be played (can be null)

setDueDate

public void setDueDate(int month,
                       int date,
                       int year,
                       int hour,
                       int min,
                       int sec)

Set date and time what the todo is due to be completed.

setEndDate

public void setEndDate(int month,
                       int date,
                       int year,
                       int hour,
                       int min,
                       int sec)

Set the date and time that the event will end.

setLocation

public void setLocation(java.lang.String loc)

set the intended location for the entity

setMailReminder

public void setMailReminder(int month,
                            int date,
                            int year,
                            int hour,
                            int min,
                            int sec,
                            java.lang.String snoozeTime,
                            int repeatCount,
                            java.lang.String emailAddress,
                            java.lang.String note)

Set the email address tht is to be sent a reminder for the entity.

Parameters:

snoozeTime - duration of time after the Run Time that the reminder is to be dormant prior to being repeated. It should be a String conformanting with the ISO 8601 basic representation for the duration of time. Eg "PT15M" (A period of 15 minutes).

repeatCount - The number of times that the reminder is to be repeated.

emailAddress - the email address that is to be sent the reminder.

note - textual reminder string that is to be sent to the email address.

setNumberRecurrences

public void setNumberRecurrences(int rec)

Set the number of times the entity will reoccur

setPriority

public void setPriority(int priority)

Set the priority of the entity.

Parameters:

priority - value of zero specifies an undefined priority. A value of one is the highest priority.

setRecurrenceDate

public void setRecurrenceDate(int month,
                              int date,
                              int year,
                              int hour,
                              int min,
                              int sec)

Set the recurring date/times of the entity. The method can be called multiple times for setting more than one recurring date/time.

setRecurrenceRule

public void setRecurrenceRule(java.lang.String rule)

Set the rule or repeating pattern for a recurring entity

setStartDate

public void setStartDate(int month,
                         int date,
                         int year,
                         int hour,
                         int min,
                         int sec)

Set the date and time that the event will start

setStatus

public void setStatus(java.lang.String status)

Set the status associated with the entity. This property can be used with the property ATTENDEE is not included in the entity.

Parameters:

status - can contain any of the attendee status defined in the class

setSummary

public void setSummary(java.lang.String summary)

Set a shory summary or subjct of the entity.