oracle.workspaces.resource.calendar
Class CwEventDefinition

java.lang.Object
oracle.workspaces.resource.CwResourceItemDefinition
oracle.workspaces.resource.calendar.CwCalendarItemDefinition
oracle.workspaces.resource.calendar.CwEventDefinition

All Implemented Interfaces:

CwCalendarConstants

public class CwEventDefinition

extends CwCalendarItemDefinition

This class represents a definition of a calendar event.

Field Summary

Fields inherited from interface oracle.workspaces.resource.calendar.CwCalendarConstants

ATTENDING_TYPE_ALL, ATTENDING_TYPE_SUBGROUP, CLASS_CONFIDENTIAL, CLASS_NORMAL, CLASS_PRIVATE, CLASS_PUBLIC, CUTYPE_GROUP, CUTYPE_INDIVIDUAL, CUTYPE_RESOURCE, CUTYPE_ROOM, CUTYPE_UNKNOWN, EVENT_STATUS_CONFIRMED, EVENT_STATUS_TENTATIVE, EVENT_TYPE_APPOINTMENT, EVENT_TYPE_DAILYNOTE, EVENT_TYPE_DAYEVENT, EVENT_TYPE_HOLIDAY, FREEBUSY_STATUS_BUSY, FREEBUSY_STATUS_FREE, FREEBUSY_STATUS_TENTATIVE, IMEETING_TYPE_REGULAR, IMEETING_TYPE_RESTRICTED, MAX_YEAR, MIN_YEAR, PARTSTAT_ACCEPTED, PARTSTAT_DECLINED, PARTSTAT_NEEDSACTION, PARTSTAT_TENTATIVE, PRIORITY_HIGH, PRIORITY_HIGHEST, PRIORITY_LOW, PRIORITY_LOWEST, PRIORITY_NORMAL, REPEATING_NO, REPEATING_UNKNOWN, REPEATING_YES, SHOWASFREE_BUSY, SHOWASFREE_FREE, SHOWASFREE_OUT, SHOWASFREE_TENTATIVE

Constructor Summary

CwEventDefinition(java.lang.String type, java.lang.String summary, java.util.Date starttime, java.util.Date endtime)
Constructor.

Method Summary

void	addAlarm(CwCalendarAlarm alarm) Adds an alarm (reminder)
void	addAttendee(CwCalendarAttendee attendee) Adds attendees to the subgroup event.
void	addRDate(java.util.Date rdate) This is used to create recurring (repeating) meetings.
void	dropAttendee(CwUser user) Drops the first attendee with the given User of the subgroup event.
void	dropRDate(java.util.Date rdate) Drops recurring dates (RDATE) from the event.
java.util.List	getAlarms() Returns a list of alarms (reminder)
java.util.List	getAttendees() Returns the list of all attendees of the subgroup event.
java.lang.String	getAttendingType() Gets attending type.
boolean	getConfirmedStatus() Gets the status for the event.
java.lang.String	getEventType() Gets event type.
java.lang.String	getIMeetingDialinInfo() Gets web conference dial in info.
boolean	getIMeetingEnabled() Returns whether this event is web conference enabled.
boolean	getIMeetingEnableDirectJoin() Returns whether include Join URL in the notification mail.
java.lang.String	getIMeetingPassword() Gets web conference password.
boolean	getIMeetingPublishAttendees() Returns whether publish attendees on the site.
java.lang.String	getLocation() Gets the location for the event
java.util.List	getRDates() Returns the list of RDATEs of the event.
boolean	isRepeatingEvent() Returns true if this is a repeating event definition.
void	setAttendees(java.util.List attendeeList) Set the attendee list.
void	setAttendingType(java.lang.String attendType) Sets event type.
void	setConfirmedStatus(boolean confirmed) Sets the status for the event.
void	setIMeetingDialinInfo(java.lang.String dialinInfo) Sets web conference dial in info.
void	setIMeetingEnabled(boolean enabled) Sets whether this event is web conference enabled.
void	setIMeetingEnableDirectJoin(boolean enabled) Sets whether include Join URL in the notification mail.
void	setIMeetingPassword(java.lang.String password) Sets web conference password.
void	setIMeetingPublishAttendees(boolean enabled) Sets whether publish attendees on the site.
void	setLocation(java.lang.String location) Sets the location for the event
void	setName(java.lang.String name) Sets name for the resource item.
void	setRDates(java.util.List dateList) This is used to create recurring (repeating) meetings.

Methods inherited from class oracle.workspaces.resource.calendar.CwCalendarItemDefinition

getEndTime, getPriority, getStartTime, getSummary, setDescription, setEndTime, setPriority, setStartTime, setSummary

Methods inherited from class oracle.workspaces.resource.CwResourceItemDefinition

getDescription, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

CwEventDefinition

public CwEventDefinition(java.lang.String type,
                         java.lang.String summary,
                         java.util.Date starttime,
                         java.util.Date endtime)
                  throws CwException

Constructor. By default it is a public which invites all workspace members. To change it, setAttendingType(ATTENDING_TYPE_SUBGROUP); and then add specific attendees.

Parameters:

type - event type. It should be one of the following values EVENT_TYPE_APPOINTMENT EVENT_TYPE_DAYEVENT EVENT_TYPE_DAILYNOTE Note: EVENT_TYPE_HOLIDAY is not supported here.

summary - title of the event

starttime - start date/time of the event

endtime - end date/time of the event

Method Detail

addAlarm

public void addAlarm(CwCalendarAlarm alarm)

Adds an alarm (reminder)

addAttendee

public void addAttendee(CwCalendarAttendee attendee)

Adds attendees to the subgroup event. This only applys to subgroup meetings. If the attending type is ATTENDING_TYPE_ALL, this is no-op.

Parameters:

attendee - Attendee to be added.

addRDate

public void addRDate(java.util.Date rdate)

This is used to create recurring (repeating) meetings. This method adds a recurrng date (RDATE) to the event. NOTE: If at least one RDATE exists for this event, this event is a repeating event.

Parameters:

rdate - Recurring date to be added.

dropAttendee

public void dropAttendee(CwUser user)

Drops the first attendee with the given User of the subgroup event. If this is ATTENDING_TYPE_ALL event, this is no-op.

Parameters:

user - CwUser object represeting the attendee to be dropped

dropRDate

public void dropRDate(java.util.Date rdate)

Drops recurring dates (RDATE) from the event.

Parameters:

rdate - Recurring date to be dropped.

getAlarms

public java.util.List getAlarms()

Returns a list of alarms (reminder)

getAttendees

public java.util.List getAttendees()

Returns the list of all attendees of the subgroup event.

getAttendingType

public java.lang.String getAttendingType()

Gets attending type. It should be one of the following values: ATTENDING_TYPE_ALL ATTENDING_TYPE_SUBGROUP

getConfirmedStatus

public boolean getConfirmedStatus()

Gets the status for the event.

Returns:

true if meeting status is Confirmed, false if status is Tentative

getEventType

public java.lang.String getEventType()

Gets event type. It should be one of the following values: EVENT_TYPE_APPOINTMENT EVENT_TYPE_DAYEVENT EVENT_TYPE_DAILYNOTE EVENT_TYPE_HOLIDAY

getIMeetingDialinInfo

public java.lang.String getIMeetingDialinInfo()
                                       throws CwException

Gets web conference dial in info. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getIMeetingEnabled

public boolean getIMeetingEnabled()
                           throws CwException

Returns whether this event is web conference enabled. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getIMeetingEnableDirectJoin

public boolean getIMeetingEnableDirectJoin()
                                    throws CwException

Returns whether include Join URL in the notification mail.

Throws:

CwException

getIMeetingPassword

public java.lang.String getIMeetingPassword()
                                     throws CwException

Gets web conference password. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getIMeetingPublishAttendees

public boolean getIMeetingPublishAttendees()
                                    throws CwException

Returns whether publish attendees on the site. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getLocation

public java.lang.String getLocation()

Gets the location for the event

Returns:

location for the event

getRDates

public java.util.List getRDates()

Returns the list of RDATEs of the event.

isRepeatingEvent

public boolean isRepeatingEvent()

Returns true if this is a repeating event definition. NOTE: If at least one RDATE exists for this event, this event is a repeating event.

setAttendees

public void setAttendees(java.util.List attendeeList)

Set the attendee list. Each object in the list must of type CwCalendarAttendee

setAttendingType

public void setAttendingType(java.lang.String attendType)

Sets event type. It should be one of the following values: ATTENDING_TYPE_ALL ATTENDING_TYPE_SUBGROUP

Parameters:

attendType - Attending type to be set.

setConfirmedStatus

public void setConfirmedStatus(boolean confirmed)

Sets the status for the event.

setIMeetingDialinInfo

public void setIMeetingDialinInfo(java.lang.String dialinInfo)
                           throws CwException

Sets web conference dial in info. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Parameters:

dialinInfo - Dial in info of the web conference.

Throws:

CwException

setIMeetingEnabled

public void setIMeetingEnabled(boolean enabled)
                        throws CwException

Sets whether this event is web conference enabled. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Parameters:

enabled - Whether it is web conference enabled.

Throws:

CwException

setIMeetingEnableDirectJoin

public void setIMeetingEnableDirectJoin(boolean enabled)
                                 throws CwException

Sets whether include Join URL in the notification mail. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Parameters:

enabled - Whether include Join URL in the notification mail.

Throws:

CwException

setIMeetingPassword

public void setIMeetingPassword(java.lang.String password)
                         throws CwException

Sets web conference password. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Parameters:

password - web conference password.

Throws:

CwException

setIMeetingPublishAttendees

public void setIMeetingPublishAttendees(boolean enabled)
                                 throws CwException

Sets whether publish attendees on the site. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Parameters:

enabled - Whether to publish attendees on the site.

Throws:

CwException

setLocation

public void setLocation(java.lang.String location)
                 throws CwAttrValException

Sets the location for the event

Parameters:

location - Location to be set

Throws:

CwAttrValException

setName

public void setName(java.lang.String name)
             throws CwAttrValException

Sets name for the resource item.

Overrides:

setName in class CwResourceItemDefinition

Throws:

CwAttrValException

setRDates

public void setRDates(java.util.List dateList)
               throws CwException

This is used to create recurring (repeating) meetings. This function sets the list of RDATEs of the event. The RDATEs define the start times for repeating meetings.

Parameters:

dateList - list of Date objects for repeating meetings

Throws:

CwException