com.sap.portal.pcm.personalization

Interface IPersonalizationSyncService

All Superinterfaces:

IService

public interface IPersonalizationSyncService
extends IService

The class that manages the synchronization of personalization data between portals.

Whenever a user on a local portal performs personalization, an IPersonalizationData object with all the details about the changes is generated. The sync service's sendLocalPersonalization(IPersonalizationData) method is called, and the object is passed as a parameter. The sendLocalPersonalization(IPersonalizationData) method then passes the object to the delivery (IPersonalizationDelivery) service, which must deliver it to the remote portal.

In the remote portal, the IPersonalizationData object must be passed to the sync service's receiveRemotePersonalization(IPersonalizationData) method, which then updates the remote portal.

If no delivery service has been implemented, the portal personalization sync process is not activated.

The name of the sync service is com.sap.portal.pcm.iviewserver.personalization.PersonalizationSyncService.

Field Summary

static int	DELIVERY_SERVICE_AVAILABLE For internal use only.
static int	DELIVERY_SERVICE_UNAVAILABLE For internal use only.
static String	KEY The service key

Method Summary

boolean	deliveryServiceAvailable() Indicates whether a delivery service exists, and whether the personalization sync service is enabled.
void	receiveRemotePersonalization(IPersonalizationData pdata) Receives information about the personalization changes done in the remote portal and applies them to the local portal.
void	sendLocalPersonalization(IPersonalizationData pdata) Searches for a delivery service that implements IPersonalizationDelivery.

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

static final String KEY

The service key

See Also:

Constant Field Values

DELIVERY_SERVICE_AVAILABLE

static final int DELIVERY_SERVICE_AVAILABLE

For internal use only.

See Also:

Constant Field Values

DELIVERY_SERVICE_UNAVAILABLE

static final int DELIVERY_SERVICE_UNAVAILABLE

For internal use only.

See Also:

Constant Field Values

Method Detail

sendLocalPersonalization

void sendLocalPersonalization(IPersonalizationData pdata)

Searches for a delivery service that implements IPersonalizationDelivery. If one exists, the generated personalization data is sent to the service. This method is called when a personalization change has been made on the local portal.

For internal use only.

Parameters:

pdata - the generated personalization data

receiveRemotePersonalization

void receiveRemotePersonalization(IPersonalizationData pdata)

Receives information about the personalization changes done in the remote portal and applies them to the local portal.

Parameters:

pdata - the personalization data

deliveryServiceAvailable

boolean deliveryServiceAvailable()

Indicates whether a delivery service exists, and whether the personalization sync service is enabled.

For internal use only.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/semantics/api	api	EP-PIN
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM