net.rim.device.api.synchronization
Interface SyncConverter

All Known Implementing Classes:
OTASyncCapableSyncItem, SyncItem

public interface SyncConverter

The SyncConverter is used to convert data from object to serialized form.

It serializes a SyncObject to produces valid synchronization data and, conversely processes synchronization data to produce a SyncObject.

In order to be recognized by the BlackBerry desktop software, data must be in the format described in ConverterUtilities.

See Also:
ConverterUtilities, SyncObject
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

Method Summary
Category: Signed  boolean convert(SyncObject object, DataBuffer buffer, int version)
          Converts a SyncObject into synchronization data.
Category: Signed  SyncObject convert(DataBuffer data, int version, int UID)
          Extracts a SyncObject from the synchronization data.
 



Method Detail

convert

boolean convert(SyncObject object,
                DataBuffer buffer,
                int version)
Converts a SyncObject into synchronization data.

Parameters:
object - The SyncObject to be converted.
buffer - The buffer into which the data will be placed. This buffer should not be rewound as it may already contain other data.
version - The version number specified with the data.
Returns:
true if the object was converted successfully; false otherwise.
See Also:
ConverterUtilities
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

convert

SyncObject convert(DataBuffer data,
                   int version,
                   int UID)
Extracts a SyncObject from the synchronization data.

Parameters:
data - The DataBuffer containing only the synchronization data. This buffer may be rewound as it will contain only the data associated with the SyncObject in question.
version - The version number specified with the data.
uid - The unique ID to be assigned to the object. If this unique ID is 0, the SyncObject must be assigned a unique ID as if it were created on the device.
Returns:
A SyncObject obtained from the synchronization data, or null if this conversion was unsuccessful.
See Also:
ConverterUtilities
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.