com.sap.ip.collaboration.core.api.scf.service

Interface SCServiceConnector

public interface SCServiceConnector

This interface defines methods that an SC Service Connector must implement.

Method Summary

void	addUserToSCSession(ProviderSession providerSession, UserInfo userInfo, com.sapportals.portal.prt.component.IPortalComponentRequest request) This method is called when a user wants to enter an SC Session.
void	cancelSCSession(String providerSessionId, UserInfo userInfo, com.sapportals.portal.prt.component.IPortalComponentRequest request) Cancels the SC Session.
String	getProviderName(com.sapportals.portal.prt.component.IPortalComponentRequest portalRequest) This method get the provider name
String	getSCServiceTypeDisplayName(String scServiceTypeKey, com.sapportals.portal.prt.component.IPortalComponentRequest portalRequest) This method gets the display name for the service type
void	setupSCSession(ProviderSession providerSession, UserInfo userInfo, com.sapportals.portal.prt.component.IPortalComponentRequest request) Prepares an SC Session.
void	updateSCSession(String providerSessionId, ProviderSession providerSession, UserInfo userInfo, com.sapportals.portal.prt.component.IPortalComponentRequest request) Updates the SC Session.

Method Detail

getSCServiceTypeDisplayName

String getSCServiceTypeDisplayName(String scServiceTypeKey,
                                   com.sapportals.portal.prt.component.IPortalComponentRequest portalRequest)

This method gets the display name for the service type

Parameters:

scServiceTypeKey - which is the key in the ResourceBundle

portalRequest - from which the locale can be obtained

getProviderName

String getProviderName(com.sapportals.portal.prt.component.IPortalComponentRequest portalRequest)

This method get the provider name

Parameters:

portalRequest -

setupSCSession

void setupSCSession(ProviderSession providerSession,
                    UserInfo userInfo,
                    com.sapportals.portal.prt.component.IPortalComponentRequest request)
                    throws SCFException

Prepares an SC Session.

Parameters:

providerSession - Contains data used to setup the session

userInfo -

request -

Throws:

SCFException - Signals problems with the operation

updateSCSession

void updateSCSession(String providerSessionId,
                     ProviderSession providerSession,
                     UserInfo userInfo,
                     com.sapportals.portal.prt.component.IPortalComponentRequest request)
                     throws SCFException

Updates the SC Session.

Parameters:

providerSessionId - Service Provider's id of the session.

providerSession - Contains data used to setup the session

userInfo -

request -

Throws:

SCFException - Signals problems with the operation

cancelSCSession

void cancelSCSession(String providerSessionId,
                     UserInfo userInfo,
                     com.sapportals.portal.prt.component.IPortalComponentRequest request)
                     throws SCFException

Cancels the SC Session.

Parameters:

providerSessionId - Service Provider's id of the session.

userInfo -

request -

Throws:

SCFException - Signals problems with the operation

addUserToSCSession

void addUserToSCSession(ProviderSession providerSession,
                        UserInfo userInfo,
                        com.sapportals.portal.prt.component.IPortalComponentRequest request)
                        throws SCFException

This method is called when a user wants to enter an SC Session. If the session has not started, the connector that implements this method may choose to start the session if the user has the authority to start, or it may notify the user to wait until the session has been started.

Parameters:

providerSession - Contains data used to start the session

userInfo -

request -

Throws:

SCFException - Signals problems with the operation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/scf	api	EP-KM-COL