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

public interface ICalendarSO

SAP Copyright (c) 2002 All rights reserved

Version:

$Id$

Method Summary

java.util.Map	getApplicationData() Returns the application data of the calendar item
com.sap.netweaver.coll.attachment.IAttachmentList	getAttachmentList() Returns the attachment list the calendar item
java.util.Map	getAvailabilityInfo(IDateRange range, int timeInterval, java.util.List addresses, com.sapportals.portal.security.usermanagement.IUser user) Returns the availability information for a list of users.
java.lang.String	getContent() Returns the content of the calendar item.
java.util.Date	getEndDateTime() Returns the End date and time of the calendar item
java.lang.String	getFrom() Returns the address which sent the calendar item.
IEmailAddress	getFromAddress() Returns the email address which sent the calendar item.
java.lang.String	getID() Returns the Id of calendar item, which uniquely identifies the item.
java.lang.String	getLocation() Returns the location
java.lang.String	getMimeType() Returns the MIME type of the content of the calendar item.
java.lang.String	getOrganizer() Returns the organizer of the meeting item.
int	getReminder() Returns the reminder
com.sapportals.wcm.util.uri.RID	getRID() Returns the RID of calendar so
AvailabilityType	getShowTimeAs() Returns the showtime-as flag
java.util.Date	getStartDateTime() Returns the start date and time of the calendar item
java.lang.String	getSubject() Returns the subject of the calendar item.
java.lang.String	getTo() Returns the recipient list of the calendar item.
java.util.List	getToList() Returns the recipient list of the calendar item as a list of EmailAddresses.
java.lang.String	getTransportName(TransportType type) Returns the transport name 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	remove(com.sapportals.portal.security.usermanagement.IUser user) 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(java.util.Map customAttributes) Sets application data on the calendar item as custom attributes.
void	setAttachmentList(com.sap.netweaver.coll.attachment.IAttachmentList attachmentList) Sets the list of attachments on the calendar item.
void	setContent(java.lang.String content) Sets the body of the calendar item.
void	setEndDateTime(java.util.Date endDateTime) Sets the end date and time of the calendar item
void	setFrom(java.lang.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(java.lang.String Id) Sets the Id of calendar item, which uniquely identifies the item.
void	setLocation(java.lang.String location) Sets the location
void	setMeeting(boolean flag) Sets if the calendar item is a meeting, false otherwise.
void	setMimeType(java.lang.String mimeType) Sets the MIME type of the content of the calendar item.
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
void	setSubject(java.lang.String subject) Sets the subject of the calendar item.
void	setTo(java.lang.String to) Sets the recipient list of calendar item.
void	setToList(java.util.List to) Sets the recipient list of calendar item as a list of EmailAddresses.

Method Detail

getApplicationData

public java.util.Map getApplicationData()
                                 throws GroupwareException

Returns the application data of the calendar item

Returns:

customAttributes

Throws:

GroupwareException -

getAttachmentList

public com.sap.netweaver.coll.attachment.IAttachmentList getAttachmentList()
                                                                    throws GroupwareException

Returns the attachment list the calendar item

Returns:

IAttachmentList

Throws:

GroupwareException -

getAvailabilityInfo

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

Returns the availability information for a list of users.

Parameters:

DateRange - range date range

int - timeInterval

List - addresses list of e-mailId of users

IUser - user

Returns:

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

Throws:

GroupwareException -

getContent

public java.lang.String getContent()
                            throws GroupwareException

Returns the content of the calendar item.

Returns:

content of the calendar item

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 -

getFrom

public java.lang.String getFrom()
                         throws GroupwareException

Returns the address which sent the calendar item.

Returns:

from

Throws:

GroupwareException -

getFromAddress

public IEmailAddress getFromAddress()
                             throws GroupwareException

Returns the email address which sent the calendar item.

Returns:

from

Throws:

GroupwareException -

getID

public java.lang.String getID()
                       throws GroupwareException

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

Returns:

Id of the calendar item

Throws:

GroupwareException -

getLocation

public java.lang.String getLocation()
                             throws GroupwareException

Returns the location

Returns:

location

Throws:

GroupwareException -

getMimeType

public java.lang.String getMimeType()
                             throws GroupwareException

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

Returns:

MIMEtype

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

Throws:

GroupwareException -

getRID

public com.sapportals.wcm.util.uri.RID getRID()
                                       throws GroupwareException

Returns the RID of calendar so

Returns:

RID of the calendar so

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 -

getSubject

public java.lang.String getSubject()
                            throws GroupwareException

Returns the subject of the calendar item.

Returns:

subject of the calendar item

getTo

public java.lang.String getTo()
                       throws GroupwareException

Returns the recipient list of the calendar item.

Returns:

recipient list

Throws:

GroupwareException -

getToList

public java.util.List getToList()
                         throws GroupwareException

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

Returns:

recipient list

Throws:

GroupwareException -

getTransportName

public java.lang.String getTransportName(TransportType type)
                                  throws GroupwareException

Returns the transport name of the calendar item.

Parameters:

transport - type

Returns:

transport name

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 -

remove

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

Removes the calendar item.

Parameters:

IUser - user

Throws:

GroupwareException -

save

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

Saves the calendar item.

Parameters:

IUser - user

Throws:

GroupwareException -

send

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

Sends the calendar item to the intended recipient list.

Parameters:

IUser - user

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 -

setApplicationData

public void setApplicationData(java.util.Map customAttributes)
                        throws GroupwareException

Sets application data on the calendar item as custom attributes.

Parameters:

customAttributes -

Throws:

GroupwareException -

setAttachmentList

public void setAttachmentList(com.sap.netweaver.coll.attachment.IAttachmentList attachmentList)
                       throws GroupwareException

Sets the list of attachments on the calendar item.

Parameters:

IAttachmentList -

Throws:

GroupwareException -

setContent

public void setContent(java.lang.String content)
                throws GroupwareException

Sets the body of the calendar item.

Parameters:

content -

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 -

setFrom

public void setFrom(java.lang.String from)
             throws GroupwareException

Sets the address from which the calendar item is originating.

Parameters:

from -

Throws:

GroupwareException -

setFromAddress

public void setFromAddress(IEmailAddress from)
                    throws GroupwareException

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

Parameters:

from -

Throws:

GroupwareException -

setID

public void setID(java.lang.String Id)
           throws GroupwareException

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

Parameters:

Id - Id of the calendar item

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 -

setMimeType

public void setMimeType(java.lang.String mimeType)
                 throws GroupwareException

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

Parameters:

MIMEtype -

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:

int - reminder

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 -

setSubject

public void setSubject(java.lang.String subject)
                throws GroupwareException

Sets the subject of the calendar item.

Parameters:

subject -

Throws:

GroupwareException -

setTo

public void setTo(java.lang.String to)
           throws GroupwareException

Sets the recipient list of calendar item.

Parameters:

to - recipient list

Throws:

GroupwareException -

setToList

public void setToList(java.util.List to)
               throws GroupwareException

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

Parameters:

to - recipient list

Throws:

GroupwareException -