SHOW Signed

net.rim.device.api.synchronization
Class SyncManager

java.lang.Object
  |
  +--net.rim.device.api.synchronization.SyncManager

public abstract class SyncManager
extends Object

Handles all synchronization and backup/restore activity for the system.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.0.0

Constructor Summary
 Category: Signed protected SyncManager()
           
 
Method Summary
 Category: Signed abstract  void addSyncEventListener(SyncEventListener listener)
          Adds a SyncEventListener interested in events from the synchronization manager.
 Category: Signed abstract  void allowOTASync(SyncCollection collection, boolean allow)
          Allow OTA synchronization for the given SyncCollection.
 Category: Signed abstract  void disableSynchronization(SyncCollection collection)
          Disable synchronization for the given SyncCollection.
 Category: Signed abstract  void enableOTASync(boolean enable)
          Enable or disable OTA synchronization.
 Category: Signed abstract  void enableSynchronization(SyncCollection collection)
          Enable synchronization for the given SyncCollection.
 Category: Signed abstract  void enableSynchronization(SyncCollection collection, boolean allowOTASync)
          Enable synchronization for the given SyncCollection.
 Category: Signed abstract  void enableSynchronization(SyncCollection collection, boolean allowOTASync, int itPolicyTagForDisablingOTASync)
          Enable synchronization for the given SyncCollection.
 Category: Signed static SyncManager getInstance()
          Get the system-wide SyncManager instance.
 Category: Signed abstract  boolean isCollectionResetSupported()
          Determine if collection reset events are handled by the sync agent.
 Category: Signed abstract  boolean isOTASyncAvailable(SyncCollection collection, boolean checkAllow)
          Determine if OTA sync is available for a SyncCollection based on all the applicable criteria including IT policy, whether or not OTA sync has been disallowed, and server configuration.
 Category: Signed abstract  boolean isSerialSyncInProgress()
          Return whether or not a serial sync or backup/restore is in progress.
 Category: Signed abstract  boolean isSyncCompleted(SyncCollection collection)
          Return true if the Sync is completed for the Sync Collection provided
 Category: Signed abstract  void removeSyncEventListener(SyncEventListener listener)
          Removes a SyncEventListener interested in events from the synchronization manager.
 Category: Signed abstract  void syncImmediately(SyncCollection collection)
          Flush pending information.
 Category: Signed abstract  void triggerSlowSync(SyncCollection collection)
          Trigger Slow Sync on a collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SyncManager

protected SyncManager()
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

addSyncEventListener

public abstract void addSyncEventListener(SyncEventListener listener)
Adds a SyncEventListener interested in events from the synchronization manager.

Parameters:
listener - The SyncEventListener to add.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

allowOTASync

public abstract void allowOTASync(SyncCollection collection,
                                  boolean allow)
Allow OTA synchronization for the given SyncCollection.
Parameters:
collection - The SyncCollection to enable synchronization for.
allow - true to allow OTA synchronization; false to disallow it.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

disableSynchronization

public abstract void disableSynchronization(SyncCollection collection)
Disable synchronization for the given SyncCollection.
Parameters:
collection - The SyncCollection to disable synchronization for.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

enableOTASync

public abstract void enableOTASync(boolean enable)
Enable or disable OTA synchronization.
Parameters:
enable - true to enable OTA synchronization; false to disable it.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

enableSynchronization

public abstract void enableSynchronization(SyncCollection collection)
Enable synchronization for the given SyncCollection.
Parameters:
collection - The SyncCollection to enable synchronization for.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

enableSynchronization

public abstract void enableSynchronization(SyncCollection collection,
                                           boolean allowOTASync)
Enable synchronization for the given SyncCollection.
Parameters:
collection - The SyncCollection to enable synchronization for.
allowOTASync - true to allow OTA synchronization; false to disallow it. This parameter is ignored if the collection is not OTASyncCapable.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

enableSynchronization

public abstract void enableSynchronization(SyncCollection collection,
                                           boolean allowOTASync,
                                           int itPolicyTagForDisablingOTASync)
Enable synchronization for the given SyncCollection.
Parameters:
collection - The SyncCollection to enable synchronization for.
allowOTASync - true to allow OTA synchronization; false to disallow it. This parameter is ignored if the collection is not OTASyncCapable.
itPolicyTagForDisablingOTASync - The tag for IT policy that controls whether or not wireless sync is disabled.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getInstance

public static SyncManager getInstance()
Get the system-wide SyncManager instance.
Returns:
The system-wide SyncManager instance, or null if no SyncManager exists.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

isCollectionResetSupported

public abstract boolean isCollectionResetSupported()
Determine if collection reset events are handled by the sync agent. A prerequisite is support on the sync server for handling a delete-on-slow sync initialization requests where unmatched server records are deleted.
Returns:
True if resets are handled, false if they are ignored.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

isOTASyncAvailable

public abstract boolean isOTASyncAvailable(SyncCollection collection,
                                           boolean checkAllow)
Determine if OTA sync is available for a SyncCollection based on all the applicable criteria including IT policy, whether or not OTA sync has been disallowed, and server configuration.
Parameters:
collection - The collection to check wireless sync availability for.
checkAllow - true to include whether or not OTA sync has been allowed/disallowed in the check; false to exclude it.
Returns:
true if OTA sync is available for the collection; false otherwise.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

isSerialSyncInProgress

public abstract boolean isSerialSyncInProgress()
Return whether or not a serial sync or backup/restore is in progress.
Returns:
true if a serial sync is in progress; false otherwise.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

isSyncCompleted

public abstract boolean isSyncCompleted(SyncCollection collection)
Return true if the Sync is completed for the Sync Collection provided
Parameters:
collection - The SyncCollection to check.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removeSyncEventListener

public abstract void removeSyncEventListener(SyncEventListener listener)
Removes a SyncEventListener interested in events from the synchronization manager.

Parameters:
listener - The SyncEventListener to remove.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

syncImmediately

public abstract void syncImmediately(SyncCollection collection)
Flush pending information. Invoke this method to instruct SyncManager to sync any pending changes related to a SyncCollection
Parameters:
collection - The SyncCollection to sync.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

triggerSlowSync

public abstract void triggerSlowSync(SyncCollection collection)
Trigger Slow Sync on a collection. Invoke this method to instruct SyncManager to start slow sync on the Sync Collection.
Parameters:
collection - The Sync Collection to start slow sync on it.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.