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.

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.
List	getAttachmentList() Returns the attachment list associated with the meeting item.
Date	getEndDateTime() Returns the End date and time of the calendar item
boolean	getHasReminder() Returns if the reminder is set or not
String	getLocation() Returns the location
String	getOrganizer() Returns the organizer of the meeting item.
IRecurrenceTransport	getRecurrence() retrieve the Recurrence info associated with Calendar Item
RecurrenceStatusType	getRecurringStatus() Returns true if the appointment is a recurring appointment
int	getReminder() Returns the reminder
AvailabilityType	getShowTimeAs() Returns the showtime-as flag
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() Deprecated.
void	setAllDay(boolean vData) Sets the all day flag
void	setEndDateTime(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(String location) Sets the location
void	setMeeting(boolean flag) Sets if the calendar item is a meeting, false otherwise.
void	setOrganizer(String organizer) Sets the organizer of the meeting item (Used to create meetings on behalf of another user)
void	setRecurrence(IRecurrenceTransport recurrenceTransport) set Recurrence info on the Calendar Item
void	setRecurring(boolean flag) Deprecated.
void	setRecurringStatus(RecurrenceStatusType 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(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, remove, save, send, setApplicationData, setContent, setFrom, setFromAddress, setGroupwareManager, setID, setMimeType, setSubject, setTo, setToList, setTransport

Method Detail

setLocation

public void setLocation(String location)
                 throws GroupwareException

Sets the location

Parameters:

location - attribute of groupware item

Throws:

GroupwareException - When error occurs

getLocation

public String getLocation()
                   throws GroupwareException

Returns the location

Returns:

location attribute of groupware item

Throws:

GroupwareException - When error occurs

setReminder

public void setReminder(int reminder)
                 throws GroupwareException

Sets the reminder time

Throws:

GroupwareException - When error occurs

setHasReminder

public void setHasReminder(boolean reminder)
                    throws GroupwareException

Sets if the reminder has to be set or not.

Throws:

GroupwareException - When error occurs

getReminder

public int getReminder()
                throws GroupwareException

Returns the reminder

Returns:

reminder as integer.

Throws:

GroupwareException - When error occurs

getHasReminder

public boolean getHasReminder()
                       throws GroupwareException

Returns if the reminder is set or not

Returns:

reminder as boolean.

Throws:

GroupwareException - When error occurs

setAllDay

public void setAllDay(boolean vData)
               throws GroupwareException

Sets the all day flag

Throws:

GroupwareException - When error occurs

isAllDay

public boolean isAllDay()
                 throws GroupwareException

Returns the allday flag

Returns:

all day flag

Throws:

GroupwareException - When error occurs

setShowTimeAs

public void setShowTimeAs(AvailabilityType showTime)
                   throws GroupwareException

Sets the showtime-as flag

Throws:

GroupwareException - When error occurs

getShowTimeAs

public AvailabilityType getShowTimeAs()
                               throws GroupwareException

Returns the showtime-as flag

Returns:

how the time is displayed in the calendar

Throws:

GroupwareException - When error occurs

setStartDateTime

public void setStartDateTime(Date startDateTime)
                      throws GroupwareException

Sets the start date and time of the calendar item

Throws:

GroupwareException - When error occurs

getStartDateTime

public Date getStartDateTime()
                      throws GroupwareException

Returns the start date and time of the calendar item

Returns:

start date time

Throws:

GroupwareException - When error occurs

setEndDateTime

public void setEndDateTime(Date endDateTime)
                    throws GroupwareException

Sets the end date and time of the calendar item

Throws:

GroupwareException - When error occurs

getEndDateTime

public Date getEndDateTime()
                    throws GroupwareException

Returns the End date and time of the calendar item

Returns:

end date time

Throws:

GroupwareException - When error occurs

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 - When error occurs

setOrganizer

public void setOrganizer(String organizer)
                  throws GroupwareException

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

Parameters:

organizer -

Throws:

GroupwareException - When error occurs

getOrganizer

public String getOrganizer()
                    throws GroupwareException

Returns the organizer of the meeting item.

Returns:

organizer attribute of groupware item

Throws:

GroupwareException - When error occurs

isRecurring

public boolean isRecurring()
                    throws GroupwareException

Deprecated.

Returns true if the appointment is a recurring appointment

Returns:

boolean true if the calenedar item is recurring.

Throws:

GroupwareException - When error occurs

setRecurring

public void setRecurring(boolean flag)
                  throws GroupwareException

Deprecated.

Returns true if the appointment is a recurring appointment

Returns:

boolean true if the calenedar item is recurring.

Throws:

GroupwareException - When error occurs

setRecurringStatus

public void setRecurringStatus(RecurrenceStatusType flag)
                        throws GroupwareException

Sets if the appointment is recurring or not.

Throws:

GroupwareException - When error occurs

getRecurringStatus

public RecurrenceStatusType getRecurringStatus()
                                        throws GroupwareException

Returns true if the appointment is a recurring appointment

Returns:

boolean true if the calenedar item is recurring.

Throws:

GroupwareException - When error occurs

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 - When error occurs

setMeeting

public void setMeeting(boolean flag)
                throws GroupwareException

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

Throws:

GroupwareException - When error occurs

getAttachmentList

public List getAttachmentList()
                       throws GroupwareException

Returns the attachment list associated with the meeting item.

Returns:

List list of IAttachment

Throws:

GroupwareException - When error occurs

addAttachment

public void addAttachment(IAttachment attachment)
                   throws GroupwareException

Adds an attachment to the meeting item.

Throws:

GroupwareException - When error occurs

deleteAttachment

public void deleteAttachment(IAttachment attachment)
                      throws GroupwareException

Deleted an attachment from the meeting item.

Throws:

GroupwareException - When error occurs

deleteAttachments

public void deleteAttachments()
                       throws GroupwareException

Deleted all attachments from the meeting item.

Throws:

GroupwareException - When error occurs

setRecurrence

public void setRecurrence(IRecurrenceTransport recurrenceTransport)
                   throws GroupwareException

set Recurrence info on the Calendar Item

Parameters:

recurrenceTransport - Recurrence Object

Throws:

GroupwareException

getRecurrence

public IRecurrenceTransport getRecurrence()
                                   throws GroupwareException

retrieve the Recurrence info associated with Calendar Item

Returns:

Recurrence Object

Throws:

GroupwareException