oracle.workspaces.resource.calendar
Class CwEventProperties

java.lang.Object
oracle.workspaces.resource.CwResourceItemProperties
oracle.workspaces.resource.calendar.CwCalendarItemProperties
oracle.workspaces.resource.calendar.CwEventProperties

All Implemented Interfaces:

CwCalendarConstants, CwEntityProperties

public class CwEventProperties

extends CwCalendarItemProperties

This class represents the propeties 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

Method Summary

void	addAlarm(CwCalendarAlarm alarm) Adds an alarm (reminder)
void	addAttendee(CwCalendarAttendee attendee) Adds one attendee to the event.
void	dropAttendee(CwCalendarAttendee att) Drops the first attendee that matches the give attendee.
void	dropAttendee(CwUser user) Drops the first attendees with the give user instance.
java.util.List	getAlarms() Returns a list of alarms
CwCalendarAttendee	getAttendee(CwCalendarAttendee att) Returns the attendee that matches given the attendee.
CwCalendarAttendee	getAttendee(CwUser user) Returns the attendee given the user instance.
CwCalendarAttendee	getAttendeeByEmail(java.lang.String email) Returns the attendee given the user email Note: Any modification on the attendee will actually modify this event properties.
java.util.List	getAttendees() Returns the list of attendees.
boolean	getConfirmedStatus() Gets the status for the event.
java.lang.String	getEventGuid() Gets Calendar native event GUID.
java.lang.String	getEventType() Gets event type.
java.lang.String	getIMeetingActingHostKey() Gets web conference acting host key.
java.lang.String	getIMeetingActingHostUrl() Gets web conference acting host URL.
java.lang.String	getIMeetingDialinInfo() Sets 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	getIMeetingHostUrl() Gets web conference host URL.
java.lang.String	getIMeetingId() Returns the web conference ID.
java.lang.String	getIMeetingPassword() Gets web conference password.
boolean	getIMeetingPublishAttendees() Returns whether publish attendees on the site.
java.lang.String	getInstanceGuid() Gets Calendar native instance GUID.
java.lang.String	getLocation() Gets the location for the event
CwCalendarAttendee	getMyAttendee() Returns the current user's attendee.
int	getRepeatingStatus() Returns the repeating status.
boolean	isAttendee(CwCalendarAttendee att) Returns true if the user is the attendee.
boolean	isAttendee(CwUser user) Returns true if the user is the attendee.
void	setAlarms(java.util.List alarms) Set alarms
void	setAttendees(java.util.List attendees) Set the list of attendees
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 the name.

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

getCalUid, getCreatedTime, getDataGuid, getDescription, getEndTime, getLastModifiedTime, getName, getOwner, getPriority, getProposer, getStartTime, getSummary, setDescription, setEndTime, setPriority, setStartTime, setSummary

Methods inherited from class oracle.workspaces.resource.CwResourceItemProperties

getLastAccessTime, getLastModifiedBy, getUid

Methods inherited from class java.lang.Object

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

Method Detail

addAlarm

public void addAlarm(CwCalendarAlarm alarm)
              throws CwException

Adds an alarm (reminder)

Throws:

CwException

addAttendee

public void addAttendee(CwCalendarAttendee attendee)
                 throws CwException

Adds one attendee to the event. This only applys to subgroup events.

Parameters:

attendee - Attendee to be added.

Throws:

CwException

dropAttendee

public void dropAttendee(CwCalendarAttendee att)
                  throws CwException

Drops the first attendee that matches the give attendee. This only applys to subgroup events.

Parameters:

att - CwCalendarAttendee object representing the attendee to be dropped

Throws:

CwException

dropAttendee

public void dropAttendee(CwUser user)
                  throws CwException

Drops the first attendees with the give user instance. This only applys to subgroup events.

Parameters:

user - CwUser object representing the attendee to be dropped

Throws:

CwException

getAlarms

public java.util.List getAlarms()
                         throws CwException

Returns a list of alarms

Throws:

CwException

getAttendee

public CwCalendarAttendee getAttendee(CwCalendarAttendee att)
                               throws CwException

Returns the attendee that matches given the attendee. Note: Any modification on the attendee will actually modify this event properties.

Parameters:

att - CwCalendarAttendee object representing the attendee

Throws:

CwException

getAttendee

public CwCalendarAttendee getAttendee(CwUser user)
                               throws CwException

Returns the attendee given the user instance. Note: Any modification on the attendee will actually modify this event properties.

Parameters:

user - CwUser object representing the attendee

Throws:

CwException

getAttendeeByEmail

public CwCalendarAttendee getAttendeeByEmail(java.lang.String email)
                                      throws CwException

Returns the attendee given the user email Note: Any modification on the attendee will actually modify this event properties.

Parameters:

email - Common name of the attendee.

Throws:

CwException

getAttendees

public java.util.List getAttendees()
                            throws CwException

Returns the list of attendees. Note: Any modification on the list will actually modify this event properties. For R2.1: For all group (public) event, this method will return all attendees (all members of workspace).

Throws:

CwException

getConfirmedStatus

public boolean getConfirmedStatus()
                           throws CwException

Gets the status for the event.

Returns:

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

Throws:

CwException

getEventGuid

public java.lang.String getEventGuid()
                              throws CwException

Gets Calendar native event GUID.

Throws:

CwException

getEventType

public java.lang.String getEventType()
                              throws CwException

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

Throws:

CwException

getIMeetingActingHostKey

public java.lang.String getIMeetingActingHostKey()
                                          throws CwException

Gets web conference acting host key. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getIMeetingActingHostUrl

public java.lang.String getIMeetingActingHostUrl()
                                          throws CwException

Gets web conference acting host URL. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getIMeetingDialinInfo

public java.lang.String getIMeetingDialinInfo()
                                       throws CwException

Sets 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. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

Throws:

CwException

getIMeetingHostUrl

public java.lang.String getIMeetingHostUrl()
                                    throws CwException

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

Throws:

CwException

getIMeetingId

public java.lang.String getIMeetingId()
                               throws CwException

Returns the web conference ID. Note: This only apply to event of type EVENT_TYPE_APPOINTMENT.

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

getInstanceGuid

public java.lang.String getInstanceGuid()
                                 throws CwException

Gets Calendar native instance GUID. For repeating event, this uniquely identify each instance of that.

Throws:

CwException

getLocation

public java.lang.String getLocation()
                             throws CwException

Gets the location for the event

Returns:

location for the event

Throws:

CwException

getMyAttendee

public CwCalendarAttendee getMyAttendee()
                                 throws CwException

Returns the current user's attendee. Note: Any modification on the attendee will actually modify this event properties.

Throws:

CwException

getRepeatingStatus

public int getRepeatingStatus()

Returns the repeating status. The possible values could be: REPEATING_NO: 0 REPEATING_YES: 1 REPEATING_UNKNOWN: 2 Note: If the status is REPEATING_UNKNOWN, you can call getEventByUid() or listEventsByUid() to get the instance with the definite repeating status.

isAttendee

public boolean isAttendee(CwCalendarAttendee att)
                   throws CwException

Returns true if the user is the attendee.

Parameters:

att - attendee object

Throws:

CwException

isAttendee

public boolean isAttendee(CwUser user)
                   throws CwException

Returns true if the user is the attendee.

Parameters:

user - User object of the attendee.

Throws:

CwException

setAlarms

public void setAlarms(java.util.List alarms)
               throws CwException

Set alarms

Throws:

CwException

setAttendees

public void setAttendees(java.util.List attendees)
                  throws CwException

Set the list of attendees

Throws:

CwException

setConfirmedStatus

public void setConfirmedStatus(boolean confirmed)
                        throws CwException

Sets the status for the event.

Throws:

CwException

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 CwException

Sets the location for the event

Parameters:

location - Location to be set

Throws:

CwException

setName

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

Sets the name.

Overrides:

setName in class CwCalendarItemProperties

Parameters:

name - the name of the resource item

Throws:

CwException