com.sap.ip.collaboration.gw.api.framework.groupware
Interface ICalendarItem

All Superinterfaces:

IGroupwareItem

public interface ICalendarItem

extends IGroupwareItem

This interface represents a calendar item like meeting/appointment and extends from the IGroupwareItem interface.

Copyright (c) SAP 2002

Version:

$Revision: 1.0$

Method Summary

void	addAttachment(IAttachment attachment) Adds an attachment to the meeting item.
void	deleteAttachment(IAttachment attachment) Deleted an attachment from the meeting item.
void	deleteAttachments() Deleted all attachments from the meeting item.
java.util.List	getAttachmentList() Returns the attachment list associated with the meeting item.
java.util.Date	getEndDateTime() Returns the End date and time of the calendar item
boolean	getHasReminder() Returns if the reminder is set or not
java.lang.String	getLocation() Returns the location
java.lang.String	getOrganizer() Returns the organizer of the meeting item.
int	getReminder() Returns the reminder
AvailabilityType	getShowTimeAs() Returns the showtime-as flag
java.util.Date	getStartDateTime() Returns the start date and time of the calendar item
boolean	isAllDay() Returns the allday flag
boolean	isMeeting() Returns true if the calendar item is a meeting, false otherwise.
boolean	isMultiDay() Returns if the appointment spans over multiple days
boolean	isRecurring() Returns true if the appointment is a recurring appointment
void	setAllDay(boolean vData) Sets the all day flag
void	setEndDateTime(java.util.Date endDateTime) Sets the end date and time of the calendar item
void	setHasReminder(boolean reminder) Sets if the reminder has to be set or not.
void	setLocation(java.lang.String location) Sets the location
void	setMeeting(boolean flag) Sets if the calendar item is a meeting, false otherwise.
void	setOrganizer(java.lang.String organizer) Sets the organizer of the meeting item (Used to create meetings on behalf of another user)
void	setRecurring(boolean flag) Sets if the appointment is recurring or not.
void	setReminder(int reminder) Sets the reminder time
void	setShowTimeAs(AvailabilityType showTime) Sets the showtime-as flag
void	setStartDateTime(java.util.Date startDateTime) Sets the start date and time of the calendar item

Methods inherited from interface com.sap.ip.collaboration.gw.api.framework.groupware.IGroupwareItem

getApplicationData, getContent, getFrom, getFromAddress, getGroupwareManager, getID, getItemType, getMimeType, getSubject, getTo, getToList, getTransport, getTransportName, remove, save, send, setApplicationData, setContent, setFrom, setFromAddress, setGroupwareManager, setID, setMimeType, setSubject, setTo, setToList, setTransport

Method Detail

addAttachment

public void addAttachment(IAttachment attachment)
                   throws GroupwareException

Adds an attachment to the meeting item.

Parameters:

IAttachment - attachment

Throws:

GroupwareException -

deleteAttachment

public void deleteAttachment(IAttachment attachment)
                      throws GroupwareException

Deleted an attachment from the meeting item.

Parameters:

IAttachment - attachment object to be deleted.

Throws:

GroupwareException -

deleteAttachments

public void deleteAttachments()
                       throws GroupwareException

Deleted all attachments from the meeting item.

Parameters:

IAttachment - attachment object to be deleted.

Throws:

GroupwareException -

getAttachmentList

public java.util.List getAttachmentList()
                                 throws GroupwareException

Returns the attachment list associated with the meeting item.

Returns:

List list of IAttachment

Throws:

GroupwareException -

getEndDateTime

public java.util.Date getEndDateTime()
                              throws GroupwareException

Returns the End date and time of the calendar item

Returns:

end date time

Throws:

GroupwareException -

getHasReminder

public boolean getHasReminder()
                       throws GroupwareException

Returns if the reminder is set or not

Returns:

reminder as boolean.

Throws:

GroupwareException -

getLocation

public java.lang.String getLocation()
                             throws GroupwareException

Returns the location

Returns:

location

Throws:

GroupwareException -

getOrganizer

public java.lang.String getOrganizer()
                              throws GroupwareException

Returns the organizer of the meeting item.

Returns:

organizer

Throws:

GroupwareException -

getReminder

public int getReminder()
                throws GroupwareException

Returns the reminder

Returns:

reminder as integer.

Throws:

GroupwareException -

getShowTimeAs

public AvailabilityType getShowTimeAs()
                               throws GroupwareException

Returns the showtime-as flag

Returns:

how the time is displayed in the calendar

Throws:

GroupwareException -

getStartDateTime

public java.util.Date getStartDateTime()
                                throws GroupwareException

Returns the start date and time of the calendar item

Returns:

start date time

Throws:

GroupwareException -

isAllDay

public boolean isAllDay()
                 throws GroupwareException

Returns the allday flag

Returns:

all day flag

Throws:

GroupwareException -

isMeeting

public boolean isMeeting()
                  throws GroupwareException

Returns true if the calendar item is a meeting, false otherwise.

Returns:

boolean true if the calenedar item is a meeting.

Throws:

GroupwareException -

isMultiDay

public boolean isMultiDay()
                   throws GroupwareException

Returns if the appointment spans over multiple days

Returns:

boolean true if the calenedar item spans over multiple days false otherwise

Throws:

GroupwareException -

isRecurring

public boolean isRecurring()
                    throws GroupwareException

Returns true if the appointment is a recurring appointment

Returns:

boolean true if the calenedar item is recurring.

Throws:

GroupwareException -

setAllDay

public void setAllDay(boolean vData)
               throws GroupwareException

Sets the all day flag

Parameters:

boolean - true if the event is all day. false otherwise

Throws:

GroupwareException -

setEndDateTime

public void setEndDateTime(java.util.Date endDateTime)
                    throws GroupwareException

Sets the end date and time of the calendar item

Parameters:

Date - end date time

Throws:

GroupwareException -

setHasReminder

public void setHasReminder(boolean reminder)
                    throws GroupwareException

Sets if the reminder has to be set or not.

Parameters:

boolean - reminder true if reminder has to be set false otherwise

Throws:

GroupwareException -

setLocation

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

Sets the location

Parameters:

location -

Throws:

GroupwareException -

setMeeting

public void setMeeting(boolean flag)
                throws GroupwareException

Sets if the calendar item is a meeting, false otherwise.

Parameters:

boolean - flag

Throws:

GroupwareException -

setOrganizer

public void setOrganizer(java.lang.String organizer)
                  throws GroupwareException

Sets the organizer of the meeting item (Used to create meetings on behalf of another user)

Parameters:

organizer -

Throws:

GroupwareException -

setRecurring

public void setRecurring(boolean flag)
                  throws GroupwareException

Sets if the appointment is recurring or not.

Parameters:

boolean -

Throws:

GroupwareException -

setReminder

public void setReminder(int reminder)
                 throws GroupwareException

Sets the reminder time

Parameters:

boolean - reminder true if reminder has to be set false otherwise

Throws:

GroupwareException -

setShowTimeAs

public void setShowTimeAs(AvailabilityType showTime)
                   throws GroupwareException

Sets the showtime-as flag

Parameters:

AvailabilityType - one the SHOWTIME_XXX values from this class

Throws:

GroupwareException -

setStartDateTime

public void setStartDateTime(java.util.Date startDateTime)
                      throws GroupwareException

Sets the start date and time of the calendar item

Parameters:

Date - start date time

Throws:

GroupwareException -