SHOW Signed

net.rim.device.api.synchronization
Class SyncItem

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

All Implemented Interfaces:

Collection, SyncCollection, SyncConverter, SyncObject

Direct Known Subclasses:

OTASyncCapableSyncItem

public abstract class SyncItem

extends Object

implements SyncObject, SyncCollection, SyncConverter

Provides an implementation of SyncCollection to provide small objects with easy access to the Synchronization API. This class is used to provide backup/restore functionality to small bits of information, typically configuration options.

Implementers should extend this object and implement the abstract functions:

• getSyncName()
• getSyncName(Locale)
• getSyncVersion()
• getSyncData()
• setSyncData()

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:

SyncCollection, SyncManager.enableSynchronization(net.rim.device.api.synchronization.SyncCollection), SyncConverter, SyncObject

Constructor Summary

SyncItem()

Method Summary

	boolean	addSyncObject(SyncObject object)
	void	beginTransaction()
	void	clearSyncObjectDirty(SyncObject object)
	SyncObject	convert(DataBuffer data, int version, int uid)
	boolean	convert(SyncObject object, DataBuffer buffer, int version)
	void	endTransaction()
	SyncConverter	getSyncConverter()
	abstract boolean	getSyncData(DataBuffer buffer, int version) Gets the data of this object for use in synchronization.
	abstract String	getSyncName()
	abstract String	getSyncName(Locale locale)
	SyncObject	getSyncObject(int uid)
	int	getSyncObjectCount()
	SyncObject[]	getSyncObjects()
	abstract int	getSyncVersion()
	int	getUID()
	boolean	isSyncObjectDirty(SyncObject object)
	boolean	removeAllSyncObjects()
	boolean	removeSyncObject(SyncObject object)
	abstract boolean	setSyncData(DataBuffer buffer, int version) Sets the data of this object from the data recived through synchronization.
	void	setSyncObjectDirty(SyncObject object)
	boolean	updateSyncObject(SyncObject oldObject, SyncObject newObject)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyncItem

public SyncItem()

Since:

JDE 3.6.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

setSyncData

public abstract boolean setSyncData(DataBuffer buffer,
                                    int version)

Sets the data of this object from the data recived through synchronization.

Parameters:

buffer - The data received through synchronization.

version - The version number specified with the data.

Returns:

true if the operation was successful; false otherwise.

Since:

JDE 3.6.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.

getSyncData

public abstract boolean getSyncData(DataBuffer buffer,
                                    int version)

Gets the data of this object for use in synchronization.

Parameters:

buffer - The DataBuffer into which the data should be placed.

version - The version of the information to be provided.

Returns:

true if the operation was successful; false otherwise.

Since:

JDE 3.6.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.

getUID

public int getUID()

Description copied from interface: SyncObject

Returns the unique ID stored in this SyncObject.

Since:

JDE 3.6.0

See Also:

SyncObject.getUID()

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 boolean convert(SyncObject object,
                       DataBuffer buffer,
                       int version)

Description copied from interface: SyncConverter

Converts a SyncObject into synchronization data.

Since:

JDE 3.6.0

See Also:

SyncConverter.convert( SyncObject, DataBuffer, int )

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)

Description copied from interface: SyncConverter

Extracts a SyncObject from the synchronization data.

Since:

JDE 3.6.0

See Also:

SyncConverter.convert( DataBuffer, int, int )

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.

getSyncVersion

public abstract int getSyncVersion()

Description copied from interface: SyncCollection

Returns the current version number of this SyncCollection.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncVersion()

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.

getSyncName

public abstract String getSyncName()

Description copied from interface: SyncCollection

Returns the name of this SyncCollection. NOTE: The name that is returned must be unique across all SyncCollections.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncName()

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.

getSyncName

public abstract String getSyncName(Locale locale)

Description copied from interface: SyncCollection

Returns the translated user-friendly name of this SyncCollection.

If this returns null, then the result from getSyncName() will be shown instead.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncName()

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.

addSyncObject

public boolean addSyncObject(SyncObject object)

Description copied from interface: SyncCollection

Adds a SyncObject to this SyncCollection.

The SyncObject's dirty bit is set to clean by default.

Since:

JDE 3.6.0

See Also:

SyncCollection.addSyncObject(net.rim.device.api.synchronization.SyncObject)

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.

updateSyncObject

public boolean updateSyncObject(SyncObject oldObject,
                                SyncObject newObject)

Description copied from interface: SyncCollection

Updates a SyncObject in this SyncCollection.

The method accepts the old object to be replaced as well as the new object that will replace it in the collection. The SyncObject should subsequently be marked clean.

Since:

JDE 3.6.0

See Also:

SyncCollection.updateSyncObject(net.rim.device.api.synchronization.SyncObject, net.rim.device.api.synchronization.SyncObject)

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.

removeSyncObject

public boolean removeSyncObject(SyncObject object)

Description copied from interface: SyncCollection

Removes a SyncObject from this SyncCollection.

Since:

JDE 3.6.0

See Also:

SyncCollection.removeSyncObject(net.rim.device.api.synchronization.SyncObject)

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.

removeAllSyncObjects

public boolean removeAllSyncObjects()

Description copied from interface: SyncCollection

Called to remove all SyncObjects from the SyncCollection.

Since:

JDE 3.6.0

See Also:

SyncCollection.removeAllSyncObjects()

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.

getSyncObjects

public SyncObject[] getSyncObjects()

Description copied from interface: SyncCollection

Returns an array of SyncObjects representing all SyncObjects in this SyncCollection.

The synchronization manager assumes that it is free to manipulate this array as it requires.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncObjects()

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.

getSyncObject

public SyncObject getSyncObject(int uid)

Description copied from interface: SyncCollection

Return the SyncObject in this SyncCollection with the given UID.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncObject(int)

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.

isSyncObjectDirty

public boolean isSyncObjectDirty(SyncObject object)

Description copied from interface: SyncCollection

Determines whether a specified SyncObject is dirty.

"Dirty" refers to whether or not the object has been modified on the handheld.

Since:

JDE 3.6.0

See Also:

SyncCollection.isSyncObjectDirty(net.rim.device.api.synchronization.SyncObject)

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.

setSyncObjectDirty

public void setSyncObjectDirty(SyncObject object)

Description copied from interface: SyncCollection

Marks the specified SyncObject as dirty.

"Dirty" refers to whether or not the object has been modified on the handheld.

Since:

JDE 3.6.0

See Also:

SyncCollection.setSyncObjectDirty(net.rim.device.api.synchronization.SyncObject)

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.

clearSyncObjectDirty

public void clearSyncObjectDirty(SyncObject object)

Description copied from interface: SyncCollection

Marks the specified SyncObject as not dirty.

"Dirty" refers to whether or not the object has been modified on the handheld.

Since:

JDE 3.6.0

See Also:

SyncCollection.clearSyncObjectDirty(net.rim.device.api.synchronization.SyncObject)

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.

getSyncObjectCount

public int getSyncObjectCount()

Description copied from interface: SyncCollection

Returns a the number of SyncObjects in this SyncCollection.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncObjectCount()

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.

getSyncConverter

public SyncConverter getSyncConverter()

Description copied from interface: SyncCollection

Returns the synchronization message converter (SyncConverter) for this SyncCollection.

A SyncConverter serializes SyncObjects and processes serialized data to create SyncObjects.

Since:

JDE 3.6.0

See Also:

SyncCollection.getSyncConverter()

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.

beginTransaction

public void beginTransaction()

Description copied from interface: SyncCollection

Starts a transaction.

Transactions are required to execute synchronizations that involve a large number of data records. The beginTransaction method is invoked by the SyncManager before adding, modifying or deleting a data record serially.

Since:

JDE 3.6.0

See Also:

SyncCollection.beginTransaction()

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.

endTransaction

public void endTransaction()

Description copied from interface: SyncCollection

Ends a transaction.

Transactions are required to execute synchronizations that involve a large number of data records. The endTransaction method is invoked to signal the end of the transaction.

Since:

JDE 3.6.0

See Also:

SyncCollection.endTransaction()

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.