com.sap.ip.me.api.sync
Class SyncEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.sap.ip.me.api.sync.SyncEvent
All Implemented Interfaces:
java.io.Serializable

Deprecated. Generic sync has been replaced by MBO synchronization. This class is only there for compatibility issues and will be removed in further releases of SAP NetWeaver Mobile Client

public class SyncEvent
extends java.util.EventObject

During synchronization different sync events will be fired to indicate the state of synchronization or to trigger activities like data container creation or cleanup.

Author:
SAP
See Also:
Serialized Form

Field Summary
static int LAST_INBOUND_FILE_RECEIVED
          Deprecated. Defines the time point when the inbound file for the last user arrives on the client and the device can go offline.
static int SYNC_READY
          Deprecated. Defines end of synchronization independent on success or not
static int SYNC_STARTED
          Deprecated. Defines start of synchronization
static int SYNC_SUCCESSFUL
          Deprecated. Defines successful end of synchronization
static int USER_SYNC_FINISHED
          Deprecated. This event will be called after synchronization of all users (including shared user) iff configuration MobileEngine.Sync.AllowUserSyncFinishedEvent is set to true (by default it is true).
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
SyncEvent(java.lang.Object source, int type)
          Deprecated. Constructor for the SyncEvent object
SyncEvent(java.lang.Object source, int type, java.lang.Object parameter)
          Deprecated. Constructor for the SyncEvent object
 
Method Summary
 java.lang.Object getParameter()
          Deprecated. Get parameter object for this sync event
 int getType()
          Deprecated. Returns the event type type.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SYNC_STARTED

public static final int SYNC_STARTED
Deprecated. 
Defines start of synchronization

See Also:
Constant Field Values

SYNC_READY

public static final int SYNC_READY
Deprecated. 
Defines end of synchronization independent on success or not

See Also:
Constant Field Values

SYNC_SUCCESSFUL

public static final int SYNC_SUCCESSFUL
Deprecated. 
Defines successful end of synchronization

See Also:
Constant Field Values

LAST_INBOUND_FILE_RECEIVED

public static final int LAST_INBOUND_FILE_RECEIVED
Deprecated. 
Defines the time point when the inbound file for the last user arrives on the client and the device can go offline. After this event synchronization starts the inbound processing.
Take care:
If you use Repetetive Sync (that means configuration MobileEngine.Sync.RepetitiveSyncEnabled is set to true (by default it is false)) or if you use Memory Agents (that means configuration MobileEngine.Sync.AllowUserSyncFinishedEvent is set to true (by default it is true)) this event will not be fired .

See Also:
Constant Field Values

USER_SYNC_FINISHED

public static final int USER_SYNC_FINISHED
Deprecated. 
This event will be called after synchronization of all users (including shared user) iff configuration MobileEngine.Sync.AllowUserSyncFinishedEvent is set to true (by default it is true).
This event will be used by Mobile Infrastructure agents for sending data in another shared user synchronization process.

Since:
MI 2.5 SP 06
See Also:
Constant Field Values
Constructor Detail

SyncEvent

public SyncEvent(java.lang.Object source,
                 int type)
Deprecated. 
Constructor for the SyncEvent object

Parameters:
source - Description of the Parameter
type - Description of the Parameter

SyncEvent

public SyncEvent(java.lang.Object source,
                 int type,
                 java.lang.Object parameter)
Deprecated. 
Constructor for the SyncEvent object

Parameters:
source - Source of this event
type - sync event type
Method Detail

getType

public int getType()
Deprecated. 
Returns the event type type.

Returns:
int

getParameter

public java.lang.Object getParameter()
Deprecated. 
Get parameter object for this sync event

Returns:
parameter object.