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

Interface IGroupwareItem

All Known Subinterfaces:

ICalendarItem, IMailItem, ITaskItem

public interface IGroupwareItem

This is a generic representation of the different groupware item types like, mail, meetings, task etc.

Method Summary

Map	getApplicationData() Returns the application data of the groupware item
String	getContent() Returns the content of the groupware item.
String	getFrom() Returns the address which sent the groupware item.
IEmailAddress	getFromAddress() Returns the address which sent the groupware item.
IGroupwareManager	getGroupwareManager() Returns the groupware manager associated with the groupware item.
String	getID() Returns the Id of groupware item, which uniquely identifies the item.
GroupwareItemType	getItemType() Returns the item type of the groupware item i.e. meeting, task etc.
String	getMimeType() Returns the MIME type of the content of the groupware item.
String	getSubject() Returns the subject of the groupware item.
String	getTo() Returns the recipient list of the groupware item.
List	getToList() Returns the recipient list of the groupware item as a list of EmailAddresses.
ITransport	getTransport(TransportType type) Returns the transport used by the groupware item
String	getTransportName(TransportType type) Returns the transport name of the groupware item.
void	remove(com.sapportals.portal.security.usermanagement.IUser user) Removes the groupware item.
void	remove(com.sapportals.portal.security.usermanagement.IUser user, boolean isSeries) Removes the groupware item.
void	save(com.sapportals.portal.security.usermanagement.IUser user) Saves the groupware item.
void	send(com.sapportals.portal.security.usermanagement.IUser user) Sends the groupware item to the intended recipient list.
void	setApplicationData(Map customAttributes) Sets application data on the groupware item as custom attributes.
void	setContent(String content) Sets the body of the groupware item.
void	setFrom(String from) Sets the address from which the groupware item is originating.
void	setFromAddress(IEmailAddress from) Sets the EmailAddress from which the groupware item is originating.
void	setGroupwareManager(IGroupwareManager manager) Sets a reference of the groupware manager in the groupware item.
void	setID(String Id) Sets the Id of groupware item, which uniquely identifies the item.
void	setMimeType(String mimeType) Sets the MIME type of the content of the groupware item.
void	setSubject(String subject) Sets the subject of the groupware item.
void	setTo(String to) Sets the recipient list of groupware item.
void	setToList(List to) Sets the recipient list of groupware item.
void	setTransport(ITransport transport) Sets a transport on the groupware item, which is used for save, send and fetch operations.

Method Detail

getID

public String getID()
             throws GroupwareException

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

Returns:

Id of the groupware item

Throws:

GroupwareException - When error occurs

setID

public void setID(String Id)
           throws GroupwareException

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

Parameters:

Id - Id of the groupware item

Throws:

GroupwareException - When error occurs

getItemType

public GroupwareItemType getItemType()
                              throws GroupwareException

Returns the item type of the groupware item i.e. meeting, task etc.

Returns:

item type of the groupware item

Throws:

GroupwareException - When error occurs

setTransport

public void setTransport(ITransport transport)
                  throws GroupwareException

Sets a transport on the groupware item, which is used for save, send and fetch operations.

Parameters:

transport - Transport handling this particular item.

Throws:

GroupwareException - When error occurs

setGroupwareManager

public void setGroupwareManager(IGroupwareManager manager)
                         throws GroupwareException

Sets a reference of the groupware manager in the groupware item.

Throws:

GroupwareException - When error occurs

getGroupwareManager

public IGroupwareManager getGroupwareManager()
                                      throws GroupwareException

Returns the groupware manager associated with the groupware item.

Returns:

GroupwareManager groupware manager.

Throws:

GroupwareException - When error occurs

getTransport

public ITransport getTransport(TransportType type)
                        throws GroupwareException

Returns the transport used by the groupware item

Throws:

GroupwareException - When error occurs

getTransportName

public String getTransportName(TransportType type)
                        throws GroupwareException

Returns the transport name of the groupware item.

Returns:

transport name

Throws:

GroupwareException - When error occurs

getContent

public String getContent()
                  throws GroupwareException

Returns the content of the groupware item.

Returns:

content of the groupware item

Throws:

GroupwareException - When error occurs

setContent

public void setContent(String content)
                throws GroupwareException

Sets the body of the groupware item.

Parameters:

content - content of the groupware item.

Throws:

GroupwareException - When error occurs

getSubject

public String getSubject()
                  throws GroupwareException

Returns the subject of the groupware item.

Returns:

subject of the groupware item

Throws:

GroupwareException

setSubject

public void setSubject(String subject)
                throws GroupwareException

Sets the subject of the groupware item.

Parameters:

subject - subject attribute of groupware item.

Throws:

GroupwareException - When error occurs

setTo

public void setTo(String to)
           throws GroupwareException

Sets the recipient list of groupware item.

Parameters:

to - string representing one or more recipients email address seperated by (delimiter) by semi colon(;)

Throws:

GroupwareException - When error occurs

setToList

public void setToList(List to)
               throws GroupwareException

Sets the recipient list of groupware item.

Parameters:

to - List of IEmailAddress Objects.

Throws:

GroupwareException - When error occurs

getTo

public String getTo()
             throws GroupwareException

Returns the recipient list of the groupware item.

Returns:

string representing one or more recipients email address seperated by (delimiter) by semi colon(;)

Throws:

GroupwareException - When error occurs

getToList

public List getToList()
               throws GroupwareException

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

Returns:

recipient list (List of IEmailAddress Objects).

Throws:

GroupwareException - When error occurs

setFrom

public void setFrom(String from)
             throws GroupwareException

Sets the address from which the groupware item is originating.

Parameters:

from - email address conforming to RFC 822.

Throws:

GroupwareException - When error occurs If From email address does't conform to the specification mentiond in RFC 822

getFrom

public String getFrom()
               throws GroupwareException

Returns the address which sent the groupware item.

Returns:

from from attribute of groupware item.

Throws:

GroupwareException - When error occurs

setFromAddress

public void setFromAddress(IEmailAddress from)
                    throws GroupwareException

Sets the EmailAddress from which the groupware item is originating.

Parameters:

from - EmailAddress attribute of groupware item.

Throws:

GroupwareException - When error occurs

getFromAddress

public IEmailAddress getFromAddress()
                             throws GroupwareException

Returns the address which sent the groupware item.

Returns:

from EmailAddress Object

Throws:

GroupwareException - When error occurs

save

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

Saves the groupware item.

Throws:

GroupwareException - When error occurs

send

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

Sends the groupware item to the intended recipient list.

Throws:

GroupwareException - When error occurs If TransportConfiguration fetching fails.

remove

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

Removes the groupware item.

Throws:

GroupwareException - When error occurs If TransportConfiguration fetching fails.

remove

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

Removes the groupware item.

Throws:

GroupwareException - When error occurs If TransportConfiguration fetching fails.

setMimeType

public void setMimeType(String mimeType)
                 throws GroupwareException

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

Parameters:

mimeType - MIME type of groupware item.

Throws:

GroupwareException - When error occurs

getMimeType

public String getMimeType()
                   throws GroupwareException

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

Returns:

mimetype of the groupware item.

Throws:

GroupwareException - When error occurs

setApplicationData

public void setApplicationData(Map customAttributes)
                        throws GroupwareException

Sets application data on the groupware item as custom attributes.

Parameters:

customAttributes - Map containing Custom Attributes.

Throws:

GroupwareException - When error occurs

getApplicationData

public Map getApplicationData()
                       throws GroupwareException

Returns the application data of the groupware item

Returns:

customAttributes Map containing Custom Attributes.

Throws:

GroupwareException - When error occurs