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

All Superinterfaces:

ITransport

All Known Subinterfaces:

ICalendarReadTransport

public interface IReadTransport

extends ITransport

The IReadTransport interface defines the methods for accessing and searching groupware items.

Copyright (c) SAP 2002

Version:

$Revision: 1.0$

Method Summary

IAttachment	getAttachmentContent(java.lang.String Id, java.lang.String attachmentId, IGroupwareCredentials credentials) Returns content of the attachment based on the id specified.
java.lang.String	getContent(java.lang.String Id, IGroupwareCredentials credentials) Returns content of the groupware item based on the id specified.
IGroupwareItem	getItem(java.lang.String Id, IGroupwareCredentials credentials) Returns a groupware item from the transport based on the id specified.
java.util.List	getItemList(IDateRange range, IGroupwareCredentials credentials) Returns all items from the transport for the specified date range
java.util.List	getItemList(IDateRange range, java.util.Properties searchCriteria, IGroupwareCredentials credentials) Returns all items from the transport for the specified date range and search criteria.

Methods inherited from interface com.sap.ip.collaboration.gw.api.framework.groupware.ITransport

getServerAlias, getSupportedItemType, getTransportDescription, getTransportName, getTransportType, initialize, terminate

Method Detail

getAttachmentContent

public IAttachment getAttachmentContent(java.lang.String Id,
                                        java.lang.String attachmentId,
                                        IGroupwareCredentials credentials)
                                 throws GroupwareException

Returns content of the attachment based on the id specified.

Parameters:

Id - id of the groupware item

attachmentId - id of the attchment id

IGroupwareCredentials - groupware credentials

Returns:

IAttachment

Throws:

GroupwareException -

getContent

public java.lang.String getContent(java.lang.String Id,
                                   IGroupwareCredentials credentials)
                            throws GroupwareException

Returns content of the groupware item based on the id specified.

Parameters:

Id - id of the groupware item

IGroupwareCredentials - groupware credentials

Returns:

content

Throws:

GroupwareException -

getItem

public IGroupwareItem getItem(java.lang.String Id,
                              IGroupwareCredentials credentials)
                       throws GroupwareException

Returns a groupware item from the transport based on the id specified.

Parameters:

Id - id of the groupware item

IGroupwareCredentials - groupware credentials

Returns:

groupware item

Throws:

GroupwareException -

getItemList

public java.util.List getItemList(IDateRange range,
                                  IGroupwareCredentials credentials)
                           throws GroupwareException

Returns all items from the transport for the specified date range

Parameters:

DateRange - date range for which the groupware items are fetched

IGroupwareCredentials - groupware credentials

Returns:

groupware item list

Throws:

GroupwareException -

getItemList

public java.util.List getItemList(IDateRange range,
                                  java.util.Properties searchCriteria,
                                  IGroupwareCredentials credentials)
                           throws GroupwareException

Returns all items from the transport for the specified date range and search criteria.

Parameters:

DateRange - date range for which the groupware items are fetched

IGroupwareCredentials - groupware credentials

Returns:

groupware item list

Throws:

GroupwareException -