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

All Known Subinterfaces:

ICalendarReadTransport, IMailSendTransport, IReadTransport, ISendTransport

public interface ITransport

This interface represents a 'groupware transport', which is nothing but a connector to a groupware server used for accessing/ maintaining different groupware items. This keeps the architecture generic and it is easy to plug in a new transport. There could be concrete implementations of the transport interfaces like MSExchangeCalendarTransport, or LotusDomino CalendarTransport etc..

Copyright (c) SAP 2002

Version:

$Revision: 1.0$

Method Summary

java.lang.String	getServerAlias() Returns the alias name of the server used by the transport.
GroupwareItemType	getSupportedItemType() Returns the groupware item type supported by the transport i.e Mail, Calendar, Task etc.
java.lang.String	getTransportDescription(java.util.Locale locale) Returns the description of the groupware transport.
java.lang.String	getTransportName() Returns the name of the groupware transport.
TransportType	getTransportType() Returns the transport type of the groupware transport i.e.
void	initialize(IGroupwareManager gwManager, java.util.List configuration) Initializes the groupware transport with different congiguration properties.
void	terminate() Terminates the groupware transport.

Method Detail

getServerAlias

public java.lang.String getServerAlias()

Returns the alias name of the server used by the transport.

Returns:

server name used by the transport.

getSupportedItemType

public GroupwareItemType getSupportedItemType()

Returns the groupware item type supported by the transport i.e Mail, Calendar, Task etc.

Returns:

groupware item type

getTransportDescription

public java.lang.String getTransportDescription(java.util.Locale locale)

Returns the description of the groupware transport.

Parameters:

locale -

Returns:

description

getTransportName

public java.lang.String getTransportName()

Returns the name of the groupware transport.

Returns:

transport name

getTransportType

public TransportType getTransportType()

Returns the transport type of the groupware transport i.e. READ, SEND or BOTH.

Returns:

transport type

initialize

public void initialize(IGroupwareManager gwManager,
                       java.util.List configuration)
                throws GroupwareException

Initializes the groupware transport with different congiguration properties.

Parameters:

GroupwareManager - groupware manager class intializing the transport

list - list of configuration properties

Throws:

GroupwareException -

terminate

public void terminate()
               throws GroupwareException

Terminates the groupware transport.

Throws:

GroupwareException -