public interface ICalendarSO
Modifier and Type | Method and Description |
---|---|
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)
Deprecated.
As of NetWeaver 7.1, replaced by
getAvailabilityInfo(IDateRange,int,List,com.sap.security.api.IUser) |
Map |
getAvailabilityInfo(IDateRange range,
int timeInterval,
List addresses,
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 organiser of the meeting item.
|
IRecurrenceClient |
getRecurrence() |
RecurrenceStatusType |
getRecurringStatusEnum()
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 |
getShowTimeAsEnum()
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 all day 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 |
remove(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
remove(com.sap.security.api.IUser) |
void |
remove(IUser user)
Removes the calendar item.
|
void |
remove(com.sapportals.portal.security.usermanagement.IUser user,
boolean isSeries)
Deprecated.
As of NetWeaver 7.1, replaced by
remove(com.sap.security.api.IUser,boolean) |
void |
remove(IUser user,
boolean isSeries)
Removes the calendar item.
|
void |
save(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
save(com.sap.security.api.IUser) |
void |
save(IUser user)
Saves the calendar item.
|
void |
send(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
send(com.sap.security.api.IUser) |
void |
send(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 organiser of the meeting item
(Used to create meetings on behalf of another user)
|
void |
setRecurrence(IRecurrenceClient recurrenceTransport) |
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.
|
RID getRID() throws GroupwareException
GroupwareException
- When error occursString getID() throws GroupwareException
GroupwareException
- When error occursvoid setID(String Id) throws GroupwareException
Id
- Id of the calendar itemGroupwareException
- When error occursString getTransportName(TransportType type) throws GroupwareException
type
- type of TransportGroupwareException
- When error occursString getContent() throws GroupwareException
GroupwareException
- When error occursvoid setContent(String content) throws GroupwareException
content
- ContentGroupwareException
- When error occursString getSubject() throws GroupwareException
GroupwareException
- When error occursvoid setSubject(String subject) throws GroupwareException
subject
- of calendar item.GroupwareException
- When error occursvoid setTo(String to) throws GroupwareException
to
- string representing Collection of email addresses seperated by semicolon(;)GroupwareException
- When error occursString getTo() throws GroupwareException
GroupwareException
- When error occursvoid setToList(List to) throws GroupwareException
to
- recipient list of IEmailAddress Objects.GroupwareException
- When error occursList getToList() throws GroupwareException
GroupwareException
- When error occursvoid setFrom(String from) throws GroupwareException
from
- email address conforming to RFC 822.GroupwareException
- When error occursString getFrom() throws GroupwareException
GroupwareException
- When error occursvoid setFromAddress(IEmailAddress from) throws GroupwareException
from
- IEmailAddress Object.GroupwareException
- When error occursIEmailAddress getFromAddress() throws GroupwareException
GroupwareException
- When error occursvoid save(com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
save(com.sap.security.api.IUser)
user
- object.GroupwareException
- When error occursvoid save(IUser user) throws GroupwareException
user
- object.GroupwareException
- When error occursvoid send(com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
send(com.sap.security.api.IUser)
user
- object.GroupwareException
- When error occursvoid send(IUser user) throws GroupwareException
user
- object.GroupwareException
- When error occursvoid remove(com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
remove(com.sap.security.api.IUser)
user
- user objectGroupwareException
- When error occursvoid remove(IUser user) throws GroupwareException
user
- user objectGroupwareException
- When error occursvoid remove(com.sapportals.portal.security.usermanagement.IUser user, boolean isSeries) throws GroupwareException
remove(com.sap.security.api.IUser,boolean)
user
- user objectisSeries
- isSeriesGroupwareException
- When error occursvoid remove(IUser user, boolean isSeries) throws GroupwareException
user
- user objectisSeries
- isSeriesGroupwareException
- When error occursvoid setMimeType(String mimeType) throws GroupwareException
mimeType
- MIME type of the contentGroupwareException
- When error occursString getMimeType() throws GroupwareException
GroupwareException
- When error occursvoid setApplicationData(Map customAttributes) throws GroupwareException
customAttributes
- customerAttributesGroupwareException
- When error occursMap getApplicationData() throws GroupwareException
GroupwareException
- When error occursvoid setLocation(String location) throws GroupwareException
location
- location field in the calendar itemGroupwareException
- When error occursString getLocation() throws GroupwareException
GroupwareException
- When error occursvoid setReminder(int reminder) throws GroupwareException
reminder
- reminder value for calendar item object.GroupwareException
- When error occursint getReminder() throws GroupwareException
GroupwareException
- When error occursvoid setAllDay(boolean vData) throws GroupwareException
vData
- boolean true if the event is all day. false otherwiseGroupwareException
- When error occursboolean isAllDay() throws GroupwareException
GroupwareException
- When error occursvoid setShowTimeAs(AvailabilityType showTime) throws GroupwareException
showTime
- one the SHOWTIME_XXX values from this classGroupwareException
- When error occursAvailabilityType getShowTimeAsEnum() throws GroupwareException
GroupwareException
- When error occursvoid setStartDateTime(Date startDateTime) throws GroupwareException
startDateTime
- start date and time of the calendar itemGroupwareException
- When error occursDate getStartDateTime() throws GroupwareException
GroupwareException
- When error occursvoid setEndDateTime(Date endDateTime) throws GroupwareException
endDateTime
- end date and time of the calendar itemGroupwareException
- When error occursDate getEndDateTime() throws GroupwareException
GroupwareException
- When error occursboolean isMultiDay() throws GroupwareException
GroupwareException
- When error occursvoid setOrganizer(String organizer) throws GroupwareException
organizer
- email address.GroupwareException
- When error occursString getOrganizer() throws GroupwareException
GroupwareException
- When error occursboolean isRecurring() throws GroupwareException
GroupwareException
- When error occursvoid setRecurringStatus(RecurrenceStatusType flag) throws GroupwareException
flag
- to indicate whether the Calendar object is recurring or not.GroupwareException
- When error occursRecurrenceStatusType getRecurringStatusEnum() throws GroupwareException
GroupwareException
- When error occursboolean isMeeting() throws GroupwareException
GroupwareException
- When error occursvoid setMeeting(boolean flag) throws GroupwareException
flag
- flagGroupwareException
- When error occursMap getAvailabilityInfo(IDateRange range, int timeInterval, List addresses, com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
getAvailabilityInfo(IDateRange,int,List,com.sap.security.api.IUser)
range
- date rangetimeInterval
- timeintervaladdresses
- list of e-mailId of usersuser
- objectGroupwareException
- When error occursMap getAvailabilityInfo(IDateRange range, int timeInterval, List addresses, IUser user) throws GroupwareException
range
- range date rangetimeInterval
- timeintervaladdresses
- list of e-mailId of usersuser
- objectGroupwareException
- When error occursObject getAttachmentList() throws GroupwareException
GroupwareException
- When error occursvoid setAttachmentList(Object attachmentList) throws GroupwareException, IllegalArgumentException
attachmentList
- ObjectGroupwareException
- When error occursIllegalArgumentException
- When Attachment List Object is of unsupported typevoid setRecurrence(IRecurrenceClient recurrenceTransport) throws GroupwareException
recurrenceTransport
- Transport for Recurring Calendar itemsGroupwareException
- When error occursIRecurrenceClient getRecurrence() throws GroupwareException
GroupwareException
- When error occursAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-COLL
|
[sap.com] tc/kmc/coll/gw
|
api
|
EP-KM-COL
|
Copyright 2018 SAP AG Complete Copyright Notice