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


public interface InboxNotifier

SmartSync uses Notifier/ Observer design pattern for applications to access in-/ out- box. By using the InboxNotifier, with SyncBoInDeltaObserver and MessageReplyObserver interfaces, applications can:

  • Access SyncBoInDeltaData
  • Access SyncReply
  • Access MessageReply

  • This interface notifies observers when SmartSync related information arrives at the client. SmartSync related information can be one of the following:
  • SyncBo inbound delta
  • Message reply
  • For each type, observers can be registered with this notifier. Registration is not done persistently.
    Notification takes place before the SmartSync framework processes the corresponding information. E.g. any observer will be notified with SyncBo inbound delta information before the actual modification for the corresponding SyncBO takes place. The InboxNotifier concrete instance can be retrieved from SmartSyncRuntime.
    Since ME 2.1 SP 03 this interface provides the functionality for checking if the last upload request was completed already and a functionaltiy to reset the sync state to COMPLETE.

    Author:
    SAP
    See Also:
    SmartSyncRuntime

    Method Summary
     ErrorConflictInbox getErrorConflictInbox()
              Returns the ErrorConflictInbox instance.
     boolean isSyncStatusComplete()
              Returns true iff the synchronization status for last sync is complete.
     void registerMessageReplyObserver(MessageReplyObserver messageReplyObserver)
              Registers a MessageReplyObserver instance.
     void registerSyncBoInDeltaObserver(SyncBoInDeltaObserver syncBoInDeltaObserver)
              Deprecated. avoid using SyncBoInDeltaObserver which reduces performance if inbound processing. Use instead SyncReplyObserver and MessageReplyObserver to get informed about success, error or conflict responses from backend.
     void registerSyncReplyObserver(SyncReplyObserver syncReplyObserver)
              Registers a SYncReplyObserver instance.
     void resetSyncStatusToComplete()
              Resets the synchroization status for last download request to complete. .
     

    Method Detail

    registerMessageReplyObserver

    public void registerMessageReplyObserver(MessageReplyObserver messageReplyObserver)
    Registers a MessageReplyObserver instance. Registration is not persistently

    Parameters:
    messageReplyObserver - instance

    registerSyncReplyObserver

    public void registerSyncReplyObserver(SyncReplyObserver syncReplyObserver)
    Registers a SYncReplyObserver instance.
    Registration is not persistently. This means after each restart of the client the registration must be redone. Because of this there is no guarantee that application gets all callbacks for this observer.

    Parameters:
    syncReplyObserver - instance

    registerSyncBoInDeltaObserver

    public void registerSyncBoInDeltaObserver(SyncBoInDeltaObserver syncBoInDeltaObserver)
    Deprecated. avoid using SyncBoInDeltaObserver which reduces performance if inbound processing. Use instead SyncReplyObserver and MessageReplyObserver to get informed about success, error or conflict responses from backend.

    Registers a SyncBoInDeltaObserver instance.
    Registration is not persistently. This means after each restart of the client the registration must be redone. Because of this there is no guarantee that application gets all callbacks for this observer.

    Parameters:
    syncBoInDeltaObserver - instance

    isSyncStatusComplete

    public boolean isSyncStatusComplete()
    Returns true iff the synchronization status for last sync is complete.

    Returns:
    true iff the synchronization status for last sync is complete
    Since:
    ME 2.1 SP 03

    resetSyncStatusToComplete

    public void resetSyncStatusToComplete()
    Resets the synchroization status for last download request to complete. .

    Since:
    ME 2.1 SP 03

    getErrorConflictInbox

    public ErrorConflictInbox getErrorConflictInbox()
    Returns the ErrorConflictInbox instance.

    Returns:


    Copyright © 2005 SAP AG. All Rights Reserved.