Overview  Package   Class  Use  Tree  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

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.

Copyright (c) SAP 2002

Version:
$Revision: 1.0$

Method Summary
 java.util.Map getApplicationData()
          Returns the application data of the groupware item
 java.lang.String getContent()
          Returns the content of the groupware item.
 java.lang.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.
 java.lang.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.
 java.lang.String getMimeType()
          Returns the MIME type of the content of the groupware item.
 java.lang.String getSubject()
          Returns the subject of the groupware item.
 java.lang.String getTo()
          Returns the recipient list of the groupware item.
 java.util.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
 java.lang.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 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(java.util.Map customAttributes)
          Sets application data on the groupware item as custom attributes.
 void setContent(java.lang.String content)
          Sets the body of the groupware item.
 void setFrom(java.lang.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(java.lang.String Id)
          Sets the Id of groupware item, which uniquely identifies the item.
 void setMimeType(java.lang.String mimeType)
          Sets the MIME type of the content of the groupware item.
 void setSubject(java.lang.String subject)
          Sets the subject of the groupware item.
 void setTo(java.lang.String to)
          Sets the recipient list of groupware item.
 void setToList(java.util.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

getApplicationData

public java.util.Map getApplicationData()
                                 throws GroupwareException
Returns the application data of the groupware item
Returns:
customAttributes
Throws:
GroupwareException -  

getContent

public java.lang.String getContent()
                            throws GroupwareException
Returns the content of the groupware item.
Returns:
content of the groupware item
Throws:
GroupwareException -  

getFrom

public java.lang.String getFrom()
                         throws GroupwareException
Returns the address which sent the groupware item.
Returns:
from
Throws:
GroupwareException -  

getFromAddress

public IEmailAddress getFromAddress()
                             throws GroupwareException
Returns the address which sent the groupware item.
Returns:
from
Throws:
GroupwareException -  

getGroupwareManager

public IGroupwareManager getGroupwareManager()
                                      throws GroupwareException
Returns the groupware manager associated with the groupware item.
Returns:
GroupwareManager
Throws:
GroupwareException -  

getID

public java.lang.String getID()
                       throws GroupwareException
Returns the Id of groupware item, which uniquely identifies the item.
Returns:
Id of the groupware item
Throws:
GroupwareException -  

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 -  

getMimeType

public java.lang.String getMimeType()
                             throws GroupwareException
Returns the MIME type of the content of the groupware item.
Returns:
MIMEtype
Throws:
GroupwareException -  

getSubject

public java.lang.String getSubject()
                            throws GroupwareException
Returns the subject of the groupware item.
Returns:
subject of the groupware item

getTo

public java.lang.String getTo()
                       throws GroupwareException
Returns the recipient list of the groupware item.
Returns:
recipient list
Throws:
GroupwareException -  

getToList

public java.util.List getToList()
                         throws GroupwareException
Returns the recipient list of the groupware item as a list of EmailAddresses.
Returns:
recipient list
Throws:
GroupwareException -  

getTransport

public ITransport getTransport(TransportType type)
                        throws GroupwareException
Returns the transport used by the groupware item
Parameters:
transport - type
Throws:
GroupwareException -  

getTransportName

public java.lang.String getTransportName(TransportType type)
                                  throws GroupwareException
Returns the transport name of the groupware item.
Parameters:
transport - type
Returns:
transport name
Throws:
GroupwareException -  

remove

public void remove(com.sapportals.portal.security.usermanagement.IUser user)
            throws GroupwareException
Removes the groupware item.
Parameters:
IUser - user
Throws:
GroupwareException -  

save

public void save(com.sapportals.portal.security.usermanagement.IUser user)
          throws GroupwareException
Saves the groupware item.
Parameters:
IUser - user
Throws:
GroupwareException -  

send

public void send(com.sapportals.portal.security.usermanagement.IUser user)
          throws GroupwareException
Sends the groupware item to the intended recipient list.
Parameters:
IUser - user
Throws:
GroupwareException -  

setApplicationData

public void setApplicationData(java.util.Map customAttributes)
                        throws GroupwareException
Sets application data on the groupware item as custom attributes.
Parameters:
customAttributes -  
Throws:
GroupwareException -  

setContent

public void setContent(java.lang.String content)
                throws GroupwareException
Sets the body of the groupware item.
Parameters:
content -  
Throws:
GroupwareException -  

setFrom

public void setFrom(java.lang.String from)
             throws GroupwareException
Sets the address from which the groupware item is originating.
Parameters:
from -  
Throws:
GroupwareException -  

setFromAddress

public void setFromAddress(IEmailAddress from)
                    throws GroupwareException
Sets the EmailAddress from which the groupware item is originating.
Parameters:
from -  
Throws:
GroupwareException -  

setGroupwareManager

public void setGroupwareManager(IGroupwareManager manager)
                         throws GroupwareException
Sets a reference of the groupware manager in the groupware item.
Parameters:
GroupwareManager -  
Throws:
GroupwareException -  

setID

public void setID(java.lang.String Id)
           throws GroupwareException
Sets the Id of groupware item, which uniquely identifies the item.
Parameters:
Id - Id of the groupware item
Throws:
GroupwareException -  

setMimeType

public void setMimeType(java.lang.String mimeType)
                 throws GroupwareException
Sets the MIME type of the content of the groupware item.
Parameters:
MIMEtype -  
Throws:
GroupwareException -  

setSubject

public void setSubject(java.lang.String subject)
                throws GroupwareException
Sets the subject of the groupware item.
Parameters:
subject -  
Throws:
GroupwareException -  

setTo

public void setTo(java.lang.String to)
           throws GroupwareException
Sets the recipient list of groupware item.
Parameters:
to - recipient list
Throws:
GroupwareException -  

setToList

public void setToList(java.util.List to)
               throws GroupwareException
Sets the recipient list of groupware item.
Parameters:
to - List of EmailAddresses
Throws:
GroupwareException -  

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 -  
Throws:
GroupwareException -  
Overview  Package   Class  Use  Tree  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD