com.sap.ip.me.api.smartsync
Class SmartSyncRuntime

java.lang.Object
  com.sap.ip.me.api.smartsync.SmartSyncRuntime

public abstract class SmartSyncRuntime
extends java.lang.Object

The SmartSyncRuntime class provides the accessor methods to the following SmartSync facade, factory and notifier classes. These classes are provided for their specific purposes.

• SyncBoDescriptorFacade
• SyncBoDataFacade
• SmartSyncQueryFactory
• InboxNotifier
• SyncBoOutDeltaNotifier
• SyncBoDeltaRequestFacade
• SyncBoOutDeltaFacade

Author:

SAP

Constructor Summary

SmartSyncRuntime()

Method Summary

abstract InboxNotifier	getInboxNotifier() Returns an instance of the InboxNotifier class.
static SmartSyncRuntime	getInstance() Returns the static instance of this SmartSyncRuntime class.
abstract SmartSyncJQueryFactory	getJQueryFactory() Returns an instance of the SmartSyncJQueryFactory class.
abstract SmartSyncQueryFactory	getQueryFactory() Returns an instance of the SmartSyncQueryFactory class.
abstract SyncBoDataFacade	getSyncBoDataFacade() Returns an instance of the SyncBoDataFacade for the specified VisibilityType.
abstract SyncBoDataFacade	getSyncBoDataFacade(VisibilityType visibility) Deprecated.
abstract SyncBoDeltaRequestFacade	getSyncBoDeltaRequestFacade() Returns an instance of the SyncBoDeltaRequestFacade class for the specified VisibilityType..
abstract SyncBoDeltaRequestFacade	getSyncBoDeltaRequestFacade(VisibilityType visibility) Deprecated. use getSyncBoDataFacade() instead.
abstract SyncBoDescriptorFacade	getSyncBoDescriptorFacade() Returns an instance of the SyncBoDescriptorFacade class.
abstract SyncBoOutDeltaFacade	getSyncBoOutDeltaFacade() Returns an instance of the SyncBoOutDeltaFacade class for the specified VisibilityType.
abstract SyncBoOutDeltaFacade	getSyncBoOutDeltaFacade(VisibilityType visibility) Deprecated.
abstract SyncBoOutDeltaNotifier	getSyncBoOutDeltaNotifier() Returns an instance of the SyncBoOutDeltaNotifier class.
abstract void	prepareSyncBoOutDeltaExcluding(SyncBoDescriptor[] excluding) This method prepares all outbound (upload) SyncBo deltas and submits them to the synchronization layer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmartSyncRuntime

public SmartSyncRuntime()

Method Detail

getInstance

public static final SmartSyncRuntime getInstance()

Returns the static instance of this SmartSyncRuntime class.

Returns:

the static instance of this SmartSyncRuntime class

getSyncBoDescriptorFacade

public abstract SyncBoDescriptorFacade getSyncBoDescriptorFacade()

Returns an instance of the SyncBoDescriptorFacade class.

Returns:

The syncBoDescriptorFacade value

See Also:

SyncBoDescriptorFacade

getSyncBoDataFacade

public abstract SyncBoDataFacade getSyncBoDataFacade(VisibilityType visibility)

Deprecated.

Returns an instance of the SyncBoDataFacade for the specified VisibilityType.

Parameters:

visibility - the visibility of the SyncBoDataFacade

Returns:

an instance of the SyncBoDataFacade for the specified VisibilityType

getSyncBoDataFacade

public abstract SyncBoDataFacade getSyncBoDataFacade()

Returns an instance of the SyncBoDataFacade for the specified VisibilityType.

Parameters:

visibility - the visibility of the SyncBoDataFacade

Returns:

an instance of the SyncBoDataFacade for the specified VisibilityType

getQueryFactory

public abstract SmartSyncQueryFactory getQueryFactory()

Returns an instance of the SmartSyncQueryFactory class.

Returns:

an instance of the SmartSyncQueryFactory

getJQueryFactory

public abstract SmartSyncJQueryFactory getJQueryFactory()

Returns an instance of the SmartSyncJQueryFactory class.

Returns:

an instance of the SmartSyncJQueryFactory class.

getInboxNotifier

public abstract InboxNotifier getInboxNotifier()

Returns an instance of the InboxNotifier class.

Returns:

an instance of the InboxNotifier

getSyncBoOutDeltaNotifier

public abstract SyncBoOutDeltaNotifier getSyncBoOutDeltaNotifier()

Returns an instance of the SyncBoOutDeltaNotifier class.

Returns:

an instance of the SyncBoOutDeltaNotifier

getSyncBoDeltaRequestFacade

public abstract SyncBoDeltaRequestFacade getSyncBoDeltaRequestFacade(VisibilityType visibility)

Deprecated. use getSyncBoDataFacade() instead.

Returns an instance of the SyncBoDeltaRequestFacade class for the specified VisibilityType..

Parameters:

visibility - the visibility of the SyncBoDeltaRequestFacade. Since Smart Sync supports only VisibilityType.SEPARATED this argument will be ignored.

Returns:

an instance of the SyncBoDeltaRequestFacade for visibility type VisibilityType.SEPARATED.

getSyncBoDeltaRequestFacade

public abstract SyncBoDeltaRequestFacade getSyncBoDeltaRequestFacade()

Returns an instance of the SyncBoDeltaRequestFacade class for the specified VisibilityType..

Parameters:

visibility - the visibility of the SyncBoDeltaRequestFacade

Returns:

an instance of the SyncBoDeltaRequestFacade

getSyncBoOutDeltaFacade

public abstract SyncBoOutDeltaFacade getSyncBoOutDeltaFacade(VisibilityType visibility)

Deprecated.

Returns an instance of the SyncBoOutDeltaFacade class for the specified VisibilityType.

Parameters:

visibility - the visibility of the SyncBoOutDeltaFacade

Returns:

an instance of the SyncBoOutDeltaFacade

getSyncBoOutDeltaFacade

public abstract SyncBoOutDeltaFacade getSyncBoOutDeltaFacade()

Returns an instance of the SyncBoOutDeltaFacade class for the specified VisibilityType.

Returns:

an instance of the SyncBoOutDeltaFacade

prepareSyncBoOutDeltaExcluding

public abstract void prepareSyncBoOutDeltaExcluding(SyncBoDescriptor[] excluding)
                                             throws SmartSyncException

This method prepares all outbound (upload) SyncBo deltas and submits them to the synchronization layer. This does not include inbound (download) SyncBo delta requests. SyncBo delta requests will be generated at the timepoint of synchronization. Any delta data being generated between the timepoint of this method invocation and the actual sync timepoint will be written into the sync container at the timepoint of synchronization. SmartSync can not control any prepared delta after the method invocation. This means e.g. that prepared delta cannot be prevented from being sent any more or the synchronous / asynchronous sending mode can be influenced in any way. After calling this method all existing references to SyncBos, Rows or Fields can be inconistent with the local datastore and should be loaded newly.

Parameters:

excluding - the array of all SyncBoDescriptor that will be excluded from this process.

Throws:

SmartSyncException