SHOW Signed

net.rim.device.api.synchronization
Interface SyncConverter

All Known Implementing Classes:

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.

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 3.6.0

See Also:

ConverterUtilities, SyncObject

Method Summary

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

Method Detail

convert

public 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.

Since:

JDE 3.6.0

See Also:

ConverterUtilities

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.

convert

public 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.

Since:

JDE 3.6.0

See Also:

ConverterUtilities

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.