com.sap.ip.collaboration.gw.api.manager.calendar

Interface ICalendarSO

public interface ICalendarSO

This interface represents semantic object for calendar item

Method Summary

Map	getApplicationData() Returns the application data of the calendar item
Object	getAttachmentList() Returns the attachment list the calendar item
Map	getAvailabilityInfo(IDateRange range, int timeInterval, List addresses, com.sapportals.portal.security.usermanagement.IUser user) Returns the availability information for a list of users.
String	getContent() Returns the content of the calendar item.
Date	getEndDateTime() Returns the End date and time of the calendar item
String	getFrom() Returns the address which sent the calendar item.
IEmailAddress	getFromAddress() Returns the email address which sent the calendar item.
String	getID() Returns the Id of calendar item, which uniquely identifies the item.
String	getLocation() Returns the location
String	getMimeType() Returns the MIME type of the content of the calendar item.
String	getOrganizer() Returns the organizer of the meeting item.
IRecurrenceClient	getRecurrence() This method retrieves recurrene object from the calendar object
RecurrenceStatusType	getRecurringStatus() Returns true if the appointment is a recurring appointment else false.
int	getReminder() Returns the reminder
RID	getRID() Returns the RID of calendar so
AvailabilityType	getShowTimeAs() Returns the showtime-as flag
Date	getStartDateTime() Returns the start date and time of the calendar item
String	getSubject() Returns the subject of the calendar item.
String	getTo() Returns the recipient list of the calendar item.
List	getToList() Returns the recipient list of the calendar item as a list of EmailAddresses.
String	getTransportName(TransportType type) Returns the transport name of the calendar item.
boolean	isAllDay() Returns the allday flag to indicate whether this spans whole day or not
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	remove(com.sapportals.portal.security.usermanagement.IUser user) Removes the calendar item.
void	remove(com.sapportals.portal.security.usermanagement.IUser user, boolean isSeries) Removes the calendar item.
void	save(com.sapportals.portal.security.usermanagement.IUser user) Saves the calendar item.
void	send(com.sapportals.portal.security.usermanagement.IUser user) Sends the calendar item to the intended recipient list.
void	setAllDay(boolean vData) Sets the all day flag
void	setApplicationData(Map customAttributes) Sets application data on the calendar item as custom attributes.
void	setAttachmentList(Object attachmentList) Sets the list of attachments on the calendar item.
void	setContent(String content) Sets the body of the calendar item.
void	setEndDateTime(Date endDateTime) Sets the end date and time of the calendar item
void	setFrom(String from) Sets the address from which the calendar item is originating.
void	setFromAddress(IEmailAddress from) Sets the email address from which the calendar item is originating.
void	setID(String Id) Sets the Id of calendar item, which uniquely identifies the item.
void	setLocation(String location) Sets the location
void	setMeeting(boolean flag) Sets if the calendar item is a meeting, false otherwise.
void	setMimeType(String mimeType) Sets the MIME type of the content of the calendar item.
void	setOrganizer(String organizer) Sets the organizer of the meeting item (Used to create meetings on behalf of another user)
void	setRecurrence(IRecurrenceClient recurrenceTransport) To set recurrence object on the calendar object
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
void	setSubject(String subject) Sets the subject of the calendar item.
void	setTo(String to) Sets the recipient list of calendar item.
void	setToList(List to) Sets the recipient list of calendar item as a list of EmailAddresses.

Method Detail

getRID

public RID getRID()
           throws GroupwareException

Returns the RID of calendar so

Returns:

RID of the calendar so

Throws:

GroupwareException - When error occurs

getID

public String getID()
             throws GroupwareException

Returns the Id of calendar item, which uniquely identifies the item.

Returns:

Id of the calendar item

Throws:

GroupwareException - When error occurs

setID

public void setID(String Id)
           throws GroupwareException

Sets the Id of calendar item, which uniquely identifies the item.

Parameters:

Id - Id of the calendar item

Throws:

GroupwareException - When error occurs

getTransportName

public String getTransportName(TransportType type)
                        throws GroupwareException

Returns the transport name of the calendar item.

Returns:

transport name

Throws:

GroupwareException - When error occurs

getContent

public String getContent()
                  throws GroupwareException

Returns the content of the calendar item.

Returns:

content of the calendar item

Throws:

GroupwareException - When error occurs

setContent

public void setContent(String content)
                throws GroupwareException

Sets the body of the calendar item.

Parameters:

content - Content

Throws:

GroupwareException - When error occurs

getSubject

public String getSubject()
                  throws GroupwareException

Returns the subject of the calendar item.

Returns:

subject of the calendar item

Throws:

GroupwareException

setSubject

public void setSubject(String subject)
                throws GroupwareException

Sets the subject of the calendar item.

Parameters:

subject - of calendar item.

Throws:

GroupwareException - When error occurs

setTo

public void setTo(String to)
           throws GroupwareException

Sets the recipient list of calendar item.

Parameters:

to - string representing Collection of email addresses seperated by semicolon(;)

Throws:

GroupwareException - When error occurs

getTo

public String getTo()
             throws GroupwareException

Returns the recipient list of the calendar item.

Returns:

string representing Collection of email addresses seperated by semicolon(;)

Throws:

GroupwareException - When error occurs

setToList

public void setToList(List to)
               throws GroupwareException

Sets the recipient list of calendar item as a list of EmailAddresses.

Parameters:

to - recipient list of IEmailAddress Objects.

Throws:

GroupwareException - When error occurs

getToList

public List getToList()
               throws GroupwareException

Returns the recipient list of the calendar item as a list of EmailAddresses.

Returns:

recipient list of IEmailAddress Objects.

Throws:

GroupwareException - When error occurs

setFrom

public void setFrom(String from)
             throws GroupwareException

Sets the address from which the calendar item is originating.

Parameters:

from - email address conforming to RFC 822.

Throws:

GroupwareException - When error occurs

getFrom

public String getFrom()
               throws GroupwareException

Returns the address which sent the calendar item.

Returns:

from email address conforming to RFC 822.

Throws:

GroupwareException - When error occurs

setFromAddress

public void setFromAddress(IEmailAddress from)
                    throws GroupwareException

Sets the email address from which the calendar item is originating.

Parameters:

from - IEmailAddress Object.

Throws:

GroupwareException - When error occurs

getFromAddress

public IEmailAddress getFromAddress()
                             throws GroupwareException

Returns the email address which sent the calendar item.

Returns:

from IEmailAddress Object.

Throws:

GroupwareException - When error occurs

save

public void save(com.sapportals.portal.security.usermanagement.IUser user)
          throws GroupwareException

Saves the calendar item.

Throws:

GroupwareException - When error occurs

send

public void send(com.sapportals.portal.security.usermanagement.IUser user)
          throws GroupwareException

Sends the calendar item to the intended recipient list.

Throws:

GroupwareException - When error occurs

remove

public void remove(com.sapportals.portal.security.usermanagement.IUser user)
            throws GroupwareException

Removes the calendar item.

Throws:

GroupwareException - When error occurs

remove

public void remove(com.sapportals.portal.security.usermanagement.IUser user,
                   boolean isSeries)
            throws GroupwareException

Removes the calendar item.

Throws:

GroupwareException - When error occurs

setMimeType

public void setMimeType(String mimeType)
                 throws GroupwareException

Sets the MIME type of the content of the calendar item.

Throws:

GroupwareException - When error occurs

getMimeType

public String getMimeType()
                   throws GroupwareException

Returns the MIME type of the content of the calendar item.

Returns:

MIMEtype

Throws:

GroupwareException - When error occurs

setApplicationData

public void setApplicationData(Map customAttributes)
                        throws GroupwareException

Sets application data on the calendar item as custom attributes.

Parameters:

customAttributes -

Throws:

GroupwareException - When error occurs

getApplicationData

public Map getApplicationData()
                       throws GroupwareException

Returns the application data of the calendar item

Returns:

customAttributes

Throws:

GroupwareException - When error occurs

setLocation

public void setLocation(String location)
                 throws GroupwareException

Sets the location

Parameters:

location -

Throws:

GroupwareException - When error occurs

getLocation

public String getLocation()
                   throws GroupwareException

Returns the location

Returns:

location location value for calendar item object.

Throws:

GroupwareException - When error occurs

setReminder

public void setReminder(int reminder)
                 throws GroupwareException

Sets the reminder time

Throws:

GroupwareException - When error occurs

getReminder

public int getReminder()
                throws GroupwareException

Returns the reminder

Returns:

reminder reminder value for calendar item object.

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 to indicate whether this spans whole day or not

Returns:

all day flag to indicate whether the item is all day or not.

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 - email address.

Throws:

GroupwareException - When error occurs

getOrganizer

public String getOrganizer()
                    throws GroupwareException

Returns the organizer of the meeting item.

Returns:

organizer email address.

Throws:

GroupwareException - When error occurs

isRecurring

public boolean isRecurring()
                    throws GroupwareException

Deprecated.

Returns true if the appointment is a recurring appointment else false.

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 else false.

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

getAvailabilityInfo

public Map getAvailabilityInfo(IDateRange range,
                               int timeInterval,
                               List addresses,
                               com.sapportals.portal.security.usermanagement.IUser user)
                        throws GroupwareException

Returns the availability information for a list of users.

Returns:

availibilityInformation returned as a map with the address as the key and the IAvailabilityInfo as the value

Throws:

GroupwareException - When error occurs

getAttachmentList

public Object getAttachmentList()
                         throws GroupwareException

Returns the attachment list the calendar item

Returns:

Object Attachment list Object

Throws:

GroupwareException - When error occurs

setAttachmentList

public void setAttachmentList(Object attachmentList)
                       throws GroupwareException,
                              IllegalArgumentException

Sets the list of attachments on the calendar item.

Throws:

GroupwareException - When error occurs

IllegalArgumentException - When Attachment List Object is of unsupported type

setRecurrence

public void setRecurrence(IRecurrenceClient recurrenceTransport)
                   throws GroupwareException

To set recurrence object on the calendar object

Parameters:

recurrenceTransport - recurrence Object

Throws:

GroupwareException

getRecurrence

public IRecurrenceClient getRecurrence()
                                throws GroupwareException

This method retrieves recurrene object from the calendar object

Returns:

recurrence Object

Throws:

GroupwareException