com.sap.ip.me.api.smartsync
Interface SyncBoDeltaRequestFacade

public interface SyncBoDeltaRequestFacade

SyncBoDeltaRequestFacade provides read- / modification-access to SyncBoDeltaRequest, and provides the "global reset" function. Regarding SyncBoDeltaRequest handling, SyncBoDeltaRequest for more detail.
The following description is regarding the reset processing:

Reset behavior is triggered by client device. There are two options: "a specific SyncBo reset", "global reset". Current release only supports the global reset.

Global reset means to reset the data of the application/ user binding conversation id, not the whole device data.

The sequence of outbound messages sent to backend is always "outbound delta SyncBo data", then "reset request", then "download request". "outbound delta SyncBo data" -----> "reset request" -----> "download request"

Client application has a chance to decide if the existing SyncBoOutDeltaData (outbound delta messages on device) should be submitted to backend or removed from client for the reset.

The "reset request" message and "download request" message are not necessary to be sent at same synchronization cycle.

After SmartSync sending the reset request, the remaining backend delta data in backend outbox should not be harmful to client, SmartSync handles them as usual.

After backend finishes reset process on the server side, it sends a "reset ok" MessageReply to SmartSync client, it is to notify SmartSync client and application that "the backend job has been done".

SmartSync client removes the local SyncBo data as soon as it receives the "reset ok" reply.

The greset request h is sent as synchronous synchronization mode.

Example: Request the download of a particular a SyncBo .

  SmartSyncRuntime.getSyncBoDeltaRequestFacade(VisibilityType.USER_SHARED).getSyncBoDeltaRequest(syncBoDesc)
                      .setProcessing(SyncBoDeltaRequestType.REQUEST);
  

Version:

2.1

Author:

SAP

See Also:

SyncBoDeltaRequest, GlobalResetProcessing

Method Summary

MeIterator	getAllSyncBoDeltaRequests() Gets the all SyncBoDeltaRequests.
GlobalResetProcessing	getGlobalResetProcessing() Gets the globalResetProcessing attribute.
SyncBoDeltaRequest	getSyncBoDeltaRequest(SyncBoDescriptor syncBoDescriptor) Gets a specific SyncBoDetalRequest by passing a SyncBoDescriptor parameter.
void	resetAllSyncBoDeltaRequests() Resets all SyncBoDeltaRequest values to default values.
void	setGlobalResetProcessing(GlobalResetProcessing globalResetProcessing) Sets the globalResetProcessing attribute.

Method Detail

getAllSyncBoDeltaRequests

MeIterator getAllSyncBoDeltaRequests()

Gets the all SyncBoDeltaRequests.

Returns:

The all SyncBoDeltaRequests value in an iterator

setGlobalResetProcessing

void setGlobalResetProcessing(GlobalResetProcessing globalResetProcessing)

Sets the globalResetProcessing attribute.

Parameters:

globalResetProcessing - The new globalResetProcessing value

See Also:

GlobalResetProcessing

getGlobalResetProcessing

GlobalResetProcessing getGlobalResetProcessing()

Gets the globalResetProcessing attribute.

Returns:

The globalResetProcessing value

See Also:

GlobalResetProcessing

getSyncBoDeltaRequest

SyncBoDeltaRequest getSyncBoDeltaRequest(SyncBoDescriptor syncBoDescriptor)

Gets a specific SyncBoDetalRequest by passing a SyncBoDescriptor parameter.

Parameters:

syncBoDescriptor - Specify the desired SyncBoDescriptor

Returns:

The corresponding SyncBoDeltaRequest value

resetAllSyncBoDeltaRequests

void resetAllSyncBoDeltaRequests()

Resets all SyncBoDeltaRequest values to default values. It has nothing to do with data reset.