Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.sap.ip.collaboration.gw.api.framework.groupware

Interface IGroupwareManager

public interface IGroupwareManager

The Groupware manager class acts as the central point for managing the different groupware item types, their storage locations, and interacting with the available transports.

Method Summary
 void clearAllTransports()
          Clears all the transports in the Registry that it holds.
 IAttachment getAttachmentContent(GroupwareItemType itemType, String transportName, String id, String attachmentId, com.sapportals.portal.security.usermanagement.IUser user)
          Returns content of the attachment based on the id specified.
 Map getAvailabilityInfo(IDateRange range, int timeInterval, List addresses, com.sapportals.portal.security.usermanagement.IUser user)
          Returns the availability information for a list of users.
 IGroupwareCredentials getCredentials(com.sapportals.portal.security.usermanagement.IUser user, String serverAlias)
           
 Properties getCredentialsProperties(int itemType, String transportName)
          Returns different credential properties needed by the specified transport.Used for fetching information from user mapping.
 IGWResourceManager getGWResourceManager()
          Returns the IGWResourceManager instance available with this manager.
 IGroupwareItem getItem(GroupwareItemType itemType, String transportName, String Id, com.sapportals.portal.security.usermanagement.IUser user)
          Returns a groupware item from the transport based on the id specified.
 List getItemList(GroupwareItemType itemType, IDateRange range, com.sapportals.portal.security.usermanagement.IUser user)
          Returns all groupware items for the specified date range.
 List getItemList(GroupwareItemType itemType, IDateRange range, Properties searchCriteria, com.sapportals.portal.security.usermanagement.IUser user, int nCount)
          Returns all groupware items for the specified date range and search attributes.
 List getSystemIds(int itemType, String transportName)
          Method get the ids of different systems for the specified transport.
 Map getTransportNames(GroupwareItemType itemType, TransportType transportType, Locale locale)
          Returns names of the available transposrts for the specified transport type.The names are returned as a map with the transport name as the key, and the description as the value.
 Map getTransports(GroupwareItemType itemType, TransportType transportType)
          Returns the available transposrts for the specified transport type.The tranpsports are returned as a map with the transport name as the key, and the transport as the value.
 void loadTransport(String transportClass, List transportProperties)
          Loads up the specified transport class, initializes it and registers the transport with transport registry.
 void loadTransport(String transportClass, List transportProperties, boolean isDefault)
          Loads up the specified transport class, initializes it and registers the transport with transport registry.
 void remove(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user)
          Saves the groupware item.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.
 void remove(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user, boolean isSeries)
          Saves the groupware item.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.
 void save(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user)
          Saves the groupware item.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.
 void send(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user)
          Sends the groupware item to the intended recipient list.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.
 void shutDown()
          Terminates the groupware manager.
 void startUp()
          Initalizes the groupware manager.
 

Method Detail

startUp

public void startUp()
             throws GroupwareException
Initalizes the groupware manager.

Throws:
GroupwareException - When error occurs

shutDown

public void shutDown()
              throws GroupwareException
Terminates the groupware manager.

Throws:
GroupwareException - When error occurs

loadTransport

public void loadTransport(String transportClass,
                          List transportProperties)
                   throws GroupwareException
Loads up the specified transport class, initializes it and registers the transport with transport registry.

Parameters:
transportClass - Class name of the transport to be loaded.
transportProperties - Transport properties.
Throws:
GroupwareException - When error occurs

loadTransport

public void loadTransport(String transportClass,
                          List transportProperties,
                          boolean isDefault)
                   throws GroupwareException
Loads up the specified transport class, initializes it and registers the transport with transport registry.

Parameters:
transportClass - Class name of the transport to be loaded.
transportProperties - Transport properties.
isDefault - true if transport (with its classname transportClass)is default or false
Throws:
GroupwareException - When error occurs

save

public void save(IGroupwareItem item,
                 com.sapportals.portal.security.usermanagement.IUser user)
          throws GroupwareException
Saves the groupware item.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.

Parameters:
item - groupware item to be saved
user - User Object
Throws:
GroupwareException - When error occurs

remove

public void remove(IGroupwareItem item,
                   com.sapportals.portal.security.usermanagement.IUser user)
            throws GroupwareException
Saves the groupware item.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.

Parameters:
item - groupware item to be saved
user - User object
Throws:
GroupwareException - When error occurs

remove

public void remove(IGroupwareItem item,
                   com.sapportals.portal.security.usermanagement.IUser user,
                   boolean isSeries)
            throws GroupwareException
Saves the groupware item.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.

Parameters:
item - groupware item to be saved
user - User object
Throws:
GroupwareException - When error occurs

send

public void send(IGroupwareItem item,
                 com.sapportals.portal.security.usermanagement.IUser user)
          throws GroupwareException
Sends the groupware item to the intended recipient list.This method obtains the necessery credentials for connecting to the groupware server from credentials factory.

Parameters:
item - groupware item to be sent
user - User object
Throws:
GroupwareException - When error occurs

getItemList

public List getItemList(GroupwareItemType itemType,
                        IDateRange range,
                        com.sapportals.portal.security.usermanagement.IUser user)
                 throws GroupwareException
Returns all groupware items for the specified date range. This method fetched groupware items from all the available read transports, merges the data, and returns the merged list.

Parameters:
itemType - groupware item type like mail, meeting, task
range - date range for which the groupware items are fetched
user - User Object
Returns:
List list of returned items sorted by date
Throws:
GroupwareException - When error occurs

getItemList

public List getItemList(GroupwareItemType itemType,
                        IDateRange range,
                        Properties searchCriteria,
                        com.sapportals.portal.security.usermanagement.IUser user,
                        int nCount)
                 throws GroupwareException
Returns all groupware items for the specified date range and search attributes. This method fetches groupware items from all the available read transports, merges the data, and returns the merged list.

Parameters:
itemType - groupware item type like mail, meeting, task
range - date range for which the groupware items are fetched
searchCriteria - search criteria to search in groupware server groupware items
user - User object
Returns:
List list of returned items sorted by date
Throws:
GroupwareException - When error occurs

getItem

public IGroupwareItem getItem(GroupwareItemType itemType,
                              String transportName,
                              String Id,
                              com.sapportals.portal.security.usermanagement.IUser user)
                       throws GroupwareException
Returns a groupware item from the transport based on the id specified.

Parameters:
itemType - groupware item type like mail, meeting, task
transportName - name of the transport from which the item will be fetched
Id - id of the groupware item
user - User Object
Returns:
IGroupwareItem Groupware Item
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

getTransportNames

public Map getTransportNames(GroupwareItemType itemType,
                             TransportType transportType,
                             Locale locale)
Returns names of the available transposrts for the specified transport type.The names are returned as a map with the transport name as the key, and the description as the value.

Parameters:
itemType - groupware item type like mail, meeting, task
transportType - transport types like read, or send transport
locale - locale for the description text
Returns:
Map Containing the groupware transports information (Transport Name - description pairs).

getTransports

public Map getTransports(GroupwareItemType itemType,
                         TransportType transportType)
Returns the available transposrts for the specified transport type.The tranpsports are returned as a map with the transport name as the key, and the transport as the value.

Parameters:
itemType - groupware item type like mail, meeting, task
transportType - transport types like read, or send transport
Returns:
List of registered transports for given GroupwareItem type and Transport type

getCredentialsProperties

public Properties getCredentialsProperties(int itemType,
                                           String transportName)
                                    throws GroupwareException
Returns different credential properties needed by the specified transport.Used for fetching information from user mapping.

Parameters:
itemType - groupware item type like mail, meeting, task
transportName - name of the transport
Returns:
credential properties
Throws:
GroupwareException - When error occurs

getAttachmentContent

public IAttachment getAttachmentContent(GroupwareItemType itemType,
                                        String transportName,
                                        String id,
                                        String attachmentId,
                                        com.sapportals.portal.security.usermanagement.IUser user)
                                 throws GroupwareException
Returns content of the attachment based on the id specified.

Parameters:
itemType - groupware item type like mail, meeting, task
transportName - name of the transport from which the item will be fetched
id - id of the groupware item
attachmentId - id of the attchment
Returns:
Attachment Object
Throws:
GroupwareException - When error occurs

getSystemIds

public List getSystemIds(int itemType,
                         String transportName)
Method get the ids of different systems for the specified transport.

Parameters:
itemType - groupware item type like mail, meeting, task
transportName - name of the transport
Returns:
List list of system ids

getCredentials

public IGroupwareCredentials getCredentials(com.sapportals.portal.security.usermanagement.IUser user,
                                            String serverAlias)
                                     throws GroupwareException
Parameters:
user - User Object.
serverAlias - system name under which the user's groupware authentication information is present.
Returns:
groupware credentials of the give user.
Throws:
GroupwareException - When error occurs

getGWResourceManager

public IGWResourceManager getGWResourceManager()
                                        throws GroupwareException
Returns the IGWResourceManager instance available with this manager.

Returns:
IGWReshourceManager groupware Resource Manager
Throws:
GroupwareException - When error occurs

clearAllTransports

public void clearAllTransports()
                        throws GroupwareException
Clears all the transports in the Registry that it holds.

Throws:
GroupwareException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.