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.

Copyright (c) SAP 2002

Version:

$Revision: 1.0$

Method Summary

IGroupwareItem	createNewItem(GroupwareItemType itemType) Creates a new groupware item based on the default transport.
IGroupwareItem	createNewItem(GroupwareItemType itemType, java.lang.String transportName) Creates a new groupware item based on the specified transport.
IAttachment	getAttachmentContent(GroupwareItemType itemType, java.lang.String transportName, java.lang.String id, java.lang.String attachmentId, com.sapportals.portal.security.usermanagement.IUser user) Returns content of the attachment based on the id specified.
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.
IGroupwareCredentials	getCredentials(com.sapportals.portal.security.usermanagement.IUser user, java.lang.String serverAlias)
java.util.Properties	getCredentialsProperties(int itemType, java.lang.String transportName) Returns different credential properties needed by the specified transport.Used for fetching information from user mapping.
IGroupwareItemFactory	getGroupwareItemFactory(com.sapportals.portal.security.usermanagement.IUser user)
IGroupwareItem	getItem(GroupwareItemType itemType, java.lang.String transportName, java.lang.String Id, com.sapportals.portal.security.usermanagement.IUser user) Returns a groupware item from the transport based on the id specified.
java.util.List	getItemList(GroupwareItemType itemType, IDateRange range, com.sapportals.portal.security.usermanagement.IUser user) Returns all groupware items for the specified date range.
java.util.List	getItemList(GroupwareItemType itemType, IDateRange range, java.util.Properties searchCriteria, com.sapportals.portal.security.usermanagement.IUser user) Returns all groupware items for the specified date range and search attributes.
java.util.List	getSystemIds(int itemType, java.lang.String transportName) Method get the ids of different systems for the specified transport.
java.util.Map	getTransportNames(GroupwareItemType itemType, TransportType transportType, java.util.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.
void	loadTransport(java.lang.String transportClass, java.util.List transportProperties) Loads up the specified transport class, initializes it and registers the transport with transport registry.
void	loadTransport(java.lang.String transportClass, java.util.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	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

createNewItem

public IGroupwareItem createNewItem(GroupwareItemType itemType)
                             throws GroupwareException

Creates a new groupware item based on the default transport.

Parameters:

itemType - groupware item type like mail, meeting, task

Returns:

IGroupwareItem

Throws:

GroupwareException -

createNewItem

public IGroupwareItem createNewItem(GroupwareItemType itemType,
                                    java.lang.String transportName)
                             throws GroupwareException

Creates a new groupware item based on the specified transport.

Parameters:

itemType - groupware item type like mail, meeting, task

transportName - name of the transport

Returns:

IGroupwareItem

Throws:

GroupwareException -

getAttachmentContent

public IAttachment getAttachmentContent(GroupwareItemType itemType,
                                        java.lang.String transportName,
                                        java.lang.String id,
                                        java.lang.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

IUser - user

Returns:

IAttachment

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 -

getCredentials

public IGroupwareCredentials getCredentials(com.sapportals.portal.security.usermanagement.IUser user,
                                            java.lang.String serverAlias)
                                     throws GroupwareException

getCredentialsProperties

public java.util.Properties getCredentialsProperties(int itemType,
                                                     java.lang.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:

Properties credential properties

Throws:

GroupwareException -

getGroupwareItemFactory

public IGroupwareItemFactory getGroupwareItemFactory(com.sapportals.portal.security.usermanagement.IUser user)
                                              throws GroupwareException

getItem

public IGroupwareItem getItem(GroupwareItemType itemType,
                              java.lang.String transportName,
                              java.lang.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 -

Returns:

IGroupwareItem

Throws:

GroupwareException -

getItemList

public java.util.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 -

Returns:

List list of returned items sorted by date

Throws:

GroupwareException -

getItemList

public java.util.List getItemList(GroupwareItemType itemType,
                                  IDateRange range,
                                  java.util.Properties searchCriteria,
                                  com.sapportals.portal.security.usermanagement.IUser user)
                           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 -

user -

Returns:

List list of returned items sorted by date

Throws:

GroupwareException -

getSystemIds

public java.util.List getSystemIds(int itemType,
                                   java.lang.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

getTransportNames

public java.util.Map getTransportNames(GroupwareItemType itemType,
                                       TransportType transportType,
                                       java.util.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

loadTransport

public void loadTransport(java.lang.String transportClass,
                          java.util.List transportProperties)
                   throws GroupwareException

Loads up the specified transport class, initializes it and registers the transport with transport registry.

Parameters:

transportClass -

transportProperties -

Throws:

GroupwareException -

loadTransport

public void loadTransport(java.lang.String transportClass,
                          java.util.List transportProperties,
                          boolean isDefault)
                   throws GroupwareException

Loads up the specified transport class, initializes it and registers the transport with transport registry.

Parameters:

transportClass -

transportProperties -

isDefault -

Throws:

GroupwareException -

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 -

Throws:

GroupwareException -

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 -

Throws:

GroupwareException -

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 -

Throws:

GroupwareException -

shutDown

public void shutDown()
              throws GroupwareException

Terminates the groupware manager.

Throws:

GroupwareException -

startUp

public void startUp()
             throws GroupwareException

Initalizes the groupware manager.

Throws:

GroupwareException -