com.nitido.nimx.nuggets.wcap
Class Event

java.lang.Object
  com.nitido.nimx.nuggets.wcap.Component
      com.nitido.nimx.nuggets.wcap.Event

All Implemented Interfaces:

java.io.Serializable

public class Event
extends Component

The data object contains all information of an event. The description of the default constructor contains more detail about what kind of information this object has encapsulated.

See Also:

Serialized Form

Field Summary

protected java.util.Vector	_attendees
protected Duration	_duration
protected java.util.Date	_end
protected boolean	_isAllDay
protected java.util.Date	_start

Fields inherited from class com.nitido.nimx.nuggets.wcap.Component

_alarm, _created, _desc, _exdates, _exrules, _lastMod, _location, _priority, _rdates, _rid, _rrules, _sequence, _status, _timeZoneId, _title, _uid

Constructor Summary

Event(java.lang.String title, java.util.Date start)
Convenience constructor.

Event(java.lang.String uid, java.lang.String rid, java.lang.String title, java.lang.String desc, java.lang.String location, CompStatus status, java.util.Vector rdates, java.util.Vector rrules, java.util.Vector exdates, java.util.Vector exrules, Alarm alarm, int priority, int sequence, java.util.Vector attendees, boolean isAllDay, java.util.Date start, java.util.Date end, Duration duration)
Constructor for application - This is the constructor one should use when creating/adding a new Event.

Event(java.lang.String uid, java.lang.String rid, java.lang.String title, java.lang.String desc, java.lang.String location, CompStatus status, java.util.Vector rdates, java.util.Vector rrules, java.util.Vector exdates, java.util.Vector exrules, Alarm alarm, int priority, int sequence, java.util.Vector attendees, boolean isAllDay, java.util.Date start, java.util.Date end, Duration duration, java.util.Date created, java.util.Date lastMod)
Constructor for older version of application - This constructor does not require the timeZoneId parameter.

Event(java.lang.String uid, java.lang.String rid, java.lang.String title, java.lang.String desc, java.lang.String location, CompStatus status, java.util.Vector rdates, java.util.Vector rrules, java.util.Vector exdates, java.util.Vector exrules, Alarm alarm, int priority, int sequence, java.util.Vector attendees, boolean isAllDay, java.util.Date start, java.util.Date end, Duration duration, java.util.Date created, java.util.Date lastMod, java.lang.String timeZoneId)
Default Constructor - This constructor takes in parameters for intializing all of the member fields.

Event(java.lang.String uid, java.lang.String rid, java.lang.String title, java.lang.String desc, java.lang.String location, CompStatus status, java.util.Vector rdates, java.util.Vector rrules, java.util.Vector exdates, java.util.Vector exrules, Alarm alarm, java.util.Vector attendees, boolean isAllDay, java.util.Date start, java.util.Date end, Duration duration)
Proprietary Default Constructor - This constructor does not specify the priority and sequence.

Method Summary

boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.util.Vector	getAttendees() Get the attendees.
Duration	getDuration() Get the duration of the Event.
java.util.Date	getEndTime() Get the ending date/time of the Event.
boolean	getIsAllDay() Get the flag that indicates whether the Event is an all day event.
java.util.Date	getStartTime() Get the starting date/time of the Event.
void	setAttendees(java.util.Vector attendees) Set the attendees.
void	setDateTime(boolean isAllDay, java.util.Date start, java.util.Date end, Duration duration) Set the date/time of the Event.
java.lang.String	toString() Returns a meaningful message with respect to the content of the object.
java.lang.String	toWcapQuery(WcapNugget nugget, java.text.DateFormat dfDay, java.text.DateFormat dfFull) Convert the component into a string that is used for constructing a WCAP query.

Methods inherited from class com.nitido.nimx.nuggets.wcap.Component

getAlarm, getCreatedDate, getDescription, getExclusionDates, getExclusionRules, getLastModDate, getLocation, getPriority, getRecurrenceDates, getRecurrenceRules, getRid, getSequence, getStatus, getTimeZoneId, getTitle, getUid, hasRecurRule, setAlarm, setCreatedDate, setDescription, setExclusionDates, setExclusionRules, setLastModDate, setLocation, setPriority, setRecurrenceDates, setRecurrenceRules, setRid, setSequence, setStatus, setTimeZoneId, setTitle, setUid

Methods inherited from class java.lang.Object

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

Field Detail

_attendees

protected java.util.Vector _attendees

_isAllDay

protected boolean _isAllDay

_start

protected java.util.Date _start

_end

protected java.util.Date _end

_duration

protected Duration _duration

Constructor Detail

Event

public Event(java.lang.String uid,
             java.lang.String rid,
             java.lang.String title,
             java.lang.String desc,
             java.lang.String location,
             CompStatus status,
             java.util.Vector rdates,
             java.util.Vector rrules,
             java.util.Vector exdates,
             java.util.Vector exrules,
             Alarm alarm,
             int priority,
             int sequence,
             java.util.Vector attendees,
             boolean isAllDay,
             java.util.Date start,
             java.util.Date end,
             Duration duration,
             java.util.Date created,
             java.util.Date lastMod,
             java.lang.String timeZoneId)
      throws InvalidParameterException

Default Constructor - This constructor takes in parameters for intializing all of the member fields.

It should never be used by the application. It is usually invoked by the WcapNugget or future extended/customized version of the WcapNugget.

In the following parameter list, each parameter starts with a [] tag that indicates the nature of the parameter. The available tags are:

• [SERVER] - the parameter usually set by the server. You rarely need to set it.
• [REQUIRED] - the parameter must be valid if it is used for adding a new event to the server.
• [OPTIONAL] - the parameter is optional. When the object is used for adding a new event, a null value implies no value would be set for the corresponding field. When it is used for modifying an existing event, a null value implies no change to the original value.

Parameters:

uid - [SERVER] The unique id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event, you should set this parameter to null and it will be ignored.

rid - [SERVER] The recurrence id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event this parameter will be ignored. If you are modifying an event without recurrence, you may set it to string "0".

title - [REQUIRED] - The title of the Event. It must exists when creating

desc - [OPTIONAL] - The description. If it is null, the Event will have no description.

location - [OPTIONAL] - The location of the Event. If it is null, the Event will have no location.

status - [SERVER] - The component status as indicated by the server.

rdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the recurrence dates.

rrules - [OPTIONAL] - A Vector of RecurRule objects that represents the recurrence rules.

exdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the dates to be excluded from recurrence.

exrules - [OPTIONAL] - A Vector of RecurRule objects that represents the rules for the time that are excluded from the recurrence.

alarm - [OPTIONAL] - An Alarm object that represent the reminder trigger.

priority - [OPTIONAL] - The priority of the Event, with value 0=lowest priority and 9=highest priority. A negative value means the priority is not specified.

sequence - [OPTIONAL] - The sequence number of the Event. A negative value means the sequence is not specified.

attendees - [OPTIONAL] - A Vector of Attendee objects that represents the people who should attend the Event. If it is null, this event will not invite any attendee.

isAllDay - [REQUIRED] - A true value indicates this Event lasts all day.

start - [REQUIRED] - The Date object for starting time of the Event.

end - [OPTIONAL] - The Date object for ending time. This parameter is required if and only if isAllDay parameter is true. This parameter will be ignored if the event does not last all day. If this parameter is non-null, the duration parameter will be ignored.

duration - [OPTIONAL] - The Duration object for the duration time of the event.

created - [OPTIONAL] - The Date object for the creation time.

lastMod - [OPTIONAL] - The Date object for the last modification time.

timeZoneId - [OPTIONAL] - The time zone id for the notification email.

Throws:

InvalidParameterException - At least one of the required parameter is missing, or an optional parameter has invalid value.

Event

public Event(java.lang.String uid,
             java.lang.String rid,
             java.lang.String title,
             java.lang.String desc,
             java.lang.String location,
             CompStatus status,
             java.util.Vector rdates,
             java.util.Vector rrules,
             java.util.Vector exdates,
             java.util.Vector exrules,
             Alarm alarm,
             int priority,
             int sequence,
             java.util.Vector attendees,
             boolean isAllDay,
             java.util.Date start,
             java.util.Date end,
             Duration duration,
             java.util.Date created,
             java.util.Date lastMod)
      throws InvalidParameterException

Constructor for older version of application - This constructor does not require the timeZoneId parameter.

It should never be used by the application. It is usually invoked by the WcapNugget or future extended/customized version of the WcapNugget.

In the following parameter list, each parameter starts with a [] tag that indicates the nature of the parameter. The available tags are:

• [SERVER] - the parameter usually set by the server. You rarely need to set it.
• [REQUIRED] - the parameter must be valid if it is used for adding a new event to the server.
• [OPTIONAL] - the parameter is optional. When the object is used for adding a new event, a null value implies no value would be set for the corresponding field. When it is used for modifying an existing event, a null value implies no change to the original value.

Parameters:

uid - [SERVER] The unique id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event, you should set this parameter to null and it will be ignored.

rid - [SERVER] The recurrence id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event this parameter will be ignored. If you are modifying an event without recurrence, you may set it to string "0".

title - [REQUIRED] - The title of the Event. It must exists when creating

desc - [OPTIONAL] - The description. If it is null, the Event will have no description.

location - [OPTIONAL] - The location of the Event. If it is null, the Event will have no location.

status - [SERVER] - The component status as indicated by the server.

rdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the recurrence dates.

rrules - [OPTIONAL] - A Vector of RecurRule objects that represents the recurrence rules.

exdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the dates to be excluded from recurrence.

exrules - [OPTIONAL] - A Vector of RecurRule objects that represents the rules for the time that are excluded from the recurrence.

alarm - [OPTIONAL] - An Alarm object that represent the reminder trigger.

priority - [OPTIONAL] - The priority of the Event, with value 0=lowest priority and 9=highest priority. A negative value means the priority is not specified.

sequence - [OPTIONAL] - The sequence number of the Event. A negative value means the sequence is not specified.

attendees - [OPTIONAL] - A Vector of Attendee objects that represents the people who should attend the Event. If it is null, this event will not invite any attendee.

isAllDay - [REQUIRED] - A true value indicates this Event lasts all day.

start - [REQUIRED] - The Date object for starting time of the Event.

end - [OPTIONAL] - The Date object for ending time. This parameter is required if and only if isAllDay parameter is true. This parameter will be ignored if the event does not last all day. If this parameter is non-null, the duration parameter will be ignored.

duration - [OPTIONAL] - The Duration object for the duration time of the event.

created - [OPTIONAL] - The Date object for the creation time.

lastMod - [OPTIONAL] - The Date object for the last modification time.

Throws:

InvalidParameterException - At least one of the required parameter is missing, or an optional parameter has invalid value.

Event

public Event(java.lang.String uid,
             java.lang.String rid,
             java.lang.String title,
             java.lang.String desc,
             java.lang.String location,
             CompStatus status,
             java.util.Vector rdates,
             java.util.Vector rrules,
             java.util.Vector exdates,
             java.util.Vector exrules,
             Alarm alarm,
             int priority,
             int sequence,
             java.util.Vector attendees,
             boolean isAllDay,
             java.util.Date start,
             java.util.Date end,
             Duration duration)
      throws InvalidParameterException

Constructor for application - This is the constructor one should use when creating/adding a new Event.

In the following parameter list, each parameter starts with a [] tag that indicates the nature of the parameter. The available tags are:

• [SERVER] - the parameter usually set by the server. You rarely need to set it.
• [REQUIRED] - the parameter must be valid if it is used for adding a new event to the server.
• [OPTIONAL] - the parameter is optional. When the object is used for adding a new event, a null value implies no value would be set for the corresponding field. When it is used for modifying an existing event, a null value implies no change to the original value.

Parameters:

uid - [SERVER] The unique id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event, you should set this parameter to null and it will be ignored.

rid - [SERVER] The recurrence id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event this parameter will be ignored. If you are modifying an event without recurrence, you may set it to string "0".

title - [REQUIRED] - The title of the Event. It must exists when creating

desc - [OPTIONAL] - The description. If it is null, the Event will have no description.

location - [OPTIONAL] - The location of the Event. If it is null, the Event will have no location.

status - [SERVER] - The component status as indicated by the server.

rdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the recurrence dates.

rrules - [OPTIONAL] - A Vector of RecurRule objects that represents the recurrence rules.

exdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the dates to be excluded from recurrence.

exrules - [OPTIONAL] - A Vector of RecurRule objects that represents the rules for the time that are excluded from the recurrence.

alarm - [OPTIONAL] - An Alarm object that represent the reminder trigger.

priority - [OPTIONAL] - The priority of the Event, with value 0=lowest priority and 9=highest priority. A negative value means the priority is not specified.

sequence - [OPTIONAL] - The sequence number of the Event. A negative value means the sequence is not specified.

attendees - [OPTIONAL] - A Vector of Attendee objects that represents the people who should attend the Event. If it is null, this event will not invite any attendee.

isAllDay - [REQUIRED] - A true value indicates this Event lasts all day.

start - [REQUIRED] - The Date object for starting time of the Event.

end - [OPTIONAL] - The Date object for ending time. This parameter is required if and only if isAllDay parameter is true. This parameter will be ignored if the event does not last all day. If this parameter is non-null, the duration parameter will be ignored.

duration - [OPTIONAL] - The Duration object for the duration time of the event.

Throws:

InvalidParameterException - At least one of the required parameter is missing, or an optional parameter has invalid value.

Event

public Event(java.lang.String uid,
             java.lang.String rid,
             java.lang.String title,
             java.lang.String desc,
             java.lang.String location,
             CompStatus status,
             java.util.Vector rdates,
             java.util.Vector rrules,
             java.util.Vector exdates,
             java.util.Vector exrules,
             Alarm alarm,
             java.util.Vector attendees,
             boolean isAllDay,
             java.util.Date start,
             java.util.Date end,
             Duration duration)
      throws InvalidParameterException

Proprietary Default Constructor - This constructor does not specify the priority and sequence.

In the following parameter list, each parameter starts with a [] tag that indicates the nature of the parameter. The available tags are:

• [SERVER] - the parameter usually set by the server. You rarely need to set it.
• [REQUIRED] - the parameter must be valid if it is used for adding a new event to the server.
• [OPTIONAL] - the parameter is optional. When the object is used for adding a new event, a null value implies no value would be set for the corresponding field. When it is used for modifying an existing event, a null value implies no change to the original value.

Parameters:

uid - [SERVER] The unique id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event, you should set this parameter to null and it will be ignored.

rid - [SERVER] The recurrence id of the event. This parameter is required only when you are modifying an existing event. If you are adding a new event this parameter will be ignored. If you are modifying an event without recurrence, you may set it to string "0".

title - [REQUIRED] - The title of the Event. It must exists when creating

desc - [OPTIONAL] - The description. If it is null, the Event will have no description.

location - [OPTIONAL] - The location of the Event. If it is null, the Event will have no location.

status - [SERVER] - The component status as indicated by the server.

rdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the recurrence dates.

rrules - [OPTIONAL] - A Vector of RecurRule objects that represents the recurrence rules.

exdates - [OPTIONAL] - A Vector of RecurDate objects that indicates the dates to be excluded from recurrence.

exrules - [OPTIONAL] - A Vector of RecurRule objects that represents the rules for the time that are excluded from the recurrence.

alarm - [OPTIONAL] - An Alarm object that represent the reminder trigger.

attendees - [OPTIONAL] - A Vector of Attendee objects that represents the people who should attend the Event. If it is null, this event will not invite any attendee.

isAllDay - [REQUIRED] - A true value indicates this Event lasts all day.

start - [REQUIRED] - The Date object for starting time of the Event.

end - [OPTIONAL] - The Date object for ending time. This parameter is required if and only if isAllDay parameter is true. This parameter will be ignored if the event does not last all day. If this parameter is non-null, the duration parameter will be ignored.

duration - [OPTIONAL] - The Duration object for the duration time of the event.

Throws:

InvalidParameterException - At least one of the required parameter is missing, or an optional parameter has invalid value.

Event

public Event(java.lang.String title,
             java.util.Date start)
      throws InvalidParameterException

Convenience constructor. This constructor allow user to create a temporary Event with only the required attributes. It assume all the other attributes to be null and the Event is an all day event.

Throws:

InvalidParameterException - At least one of the required parameter is missing, or an optional parameter has invalid value.

Method Detail

getAttendees

public java.util.Vector getAttendees()

Get the attendees.

setAttendees

public void setAttendees(java.util.Vector attendees)

Set the attendees.

getIsAllDay

public boolean getIsAllDay()

Get the flag that indicates whether the Event is an all day event.

getStartTime

public java.util.Date getStartTime()

Get the starting date/time of the Event.

getEndTime

public java.util.Date getEndTime()

Get the ending date/time of the Event.

getDuration

public Duration getDuration()

Get the duration of the Event.

setDateTime

public void setDateTime(boolean isAllDay,
                        java.util.Date start,
                        java.util.Date end,
                        Duration duration)
                 throws InvalidParameterException

Set the date/time of the Event.

Parameters:

isAllDay - boolean flag to indicate whether the Event is an all day event. If is set to true, both parameters "end" and "duration" will be ignored.

start - Date object to indicate the starting time

end - Date object to indicate the ending time. A null value indicates no ending date/time is set. If not null, the parameter "duration" will be ignored.

duration - Duration object to indicate the duration time of the event. A null value indicates no duration value is set.

Throws:

InvalidParameterException - If the time parameter is incorrect.

toWcapQuery

public java.lang.String toWcapQuery(WcapNugget nugget,
                                    java.text.DateFormat dfDay,
                                    java.text.DateFormat dfFull)
                             throws InvalidParameterException,
                                    WcapException

Convert the component into a string that is used for constructing a WCAP query. This method is designed for internal use by the WcapNugget only.

Overrides:

toWcapQuery in class Component

Throws:

InvalidParameterException

WcapException

equals

public boolean equals(java.lang.Object inObj)

Override the default java.lang.Object's equal command. This will compares the content of the fields. In case of a vector or array field, it will compare the content of the field.

Overrides:

equals in class Component

toString

public java.lang.String toString()

Returns a meaningful message with respect to the content of the object. This is mainly used for debugging purpose.

Overrides:

toString in class Component