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

Interface ISendTransport

All Superinterfaces:

ITransport

All Known Subinterfaces:

ICalendarSendTransport, IMailSendTransport

public interface ISendTransport

extends ITransport

The ISendTransport interface defines methods for saving or sending groupware items.

Method Summary

void	remove(String id, IGroupwareCredentials credentials) Removes the groupware item based on the id specified.
String	save(IGroupwareItem item, IGroupwareCredentials credentials) Saves the groupware item using the credentials specified.
String	send(IGroupwareItem item, IGroupwareCredentials credentials) Sends the groupware item to the intended recipient list.

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

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

Method Detail

save

public String save(IGroupwareItem item,
                   IGroupwareCredentials credentials)
            throws GroupwareException

Saves the groupware item using the credentials specified.

Parameters:

item - groupware item

credentials - groupware credentials

Returns:

id of the item saved

Throws:

GroupwareException - When error occurs

send

public String send(IGroupwareItem item,
                   IGroupwareCredentials credentials)
            throws GroupwareException

Sends the groupware item to the intended recipient list.

Parameters:

item - groupware item

credentials - groupware credentials

Returns:

id of the item sent

Throws:

GroupwareException - When error occurs

remove

public void remove(String id,
                   IGroupwareCredentials credentials)
            throws GroupwareException

Removes the groupware item based on the id specified.

Throws:

GroupwareException - When error occurs