|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--net.rim.device.api.synchronization.SyncItem
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:
SyncCollection,
SyncManager.enableSynchronization(net.rim.device.api.synchronization.SyncCollection),
SyncConverter,
SyncObject| Constructor Summary | ||
|
protected |
SyncItem()
|
| Method Summary | ||
|
boolean |
addSyncObject(SyncObject object)
Adds a SyncObject to this SyncCollection. |
|
void |
beginTransaction()
Starts a transaction. |
|
void |
clearSyncObjectDirty(SyncObject object)
Marks the specified SyncObject as not dirty. |
|
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. |
|
void |
endTransaction()
Ends a transaction. |
|
SyncConverter |
getSyncConverter()
Returns the synchronization message converter ( SyncConverter)
for this SyncCollection. |
|
abstract boolean |
getSyncData(DataBuffer buffer,
int version)
Gets the data of this object for use in synchronization. |
|
abstract String |
getSyncName()
Returns the name of this SyncCollection. |
|
abstract String |
getSyncName(Locale locale)
Returns the translated user-friendly name of this SyncCollection. |
|
SyncObject |
getSyncObject(int uid)
Return the SyncObject in this SyncCollection
with the given UID. |
|
int |
getSyncObjectCount()
Returns a the number of SyncObjects in this SyncCollection. |
|
SyncObject[] |
getSyncObjects()
Returns an array of SyncObjects representing all
SyncObjects in this SyncCollection. |
|
abstract int |
getSyncVersion()
Returns the current version number of this SyncCollection. |
|
int |
getUID()
Returns the unique ID stored in this SyncObject. |
|
boolean |
isSyncObjectDirty(SyncObject object)
Determines whether a specified SyncObject is dirty. |
|
boolean |
removeAllSyncObjects()
Called to remove all SyncObjects from the SyncCollection. |
|
boolean |
removeSyncObject(SyncObject object)
Removes a SyncObject from this SyncCollection. |
|
abstract boolean |
setSyncData(DataBuffer buffer,
int version)
Sets the data of this object from the data recived through synchronization. |
|
void |
setSyncObjectDirty(SyncObject object)
Marks the specified SyncObject as dirty. |
|
boolean |
updateSyncObject(SyncObject oldObject,
SyncObject newObject)
Updates a SyncObject in this SyncCollection. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
protected SyncItem()
| Method Detail |
public boolean addSyncObject(SyncObject object)
SyncCollectionSyncObject to this SyncCollection.
The SyncObject's dirty bit is set to clean by default.
*public void beginTransaction()
SyncCollection
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.
*public void clearSyncObjectDirty(SyncObject object)
SyncCollectionSyncObject as not dirty.
"Dirty" refers to whether or not the object has been modified on the handheld.
*public SyncObject convert(DataBuffer data, int version, int uid)
SyncConverterSyncObject from the synchronization data.
*public boolean convert(SyncObject object, DataBuffer buffer, int version)
SyncConverterSyncObject into synchronization data.
*public void endTransaction()
SyncCollection
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.
*public SyncConverter getSyncConverter()
SyncCollectionSyncConverter)
for this SyncCollection.
A SyncConverter serializes SyncObjects and
processes serialized data to create SyncObjects.
*public abstract boolean getSyncData(DataBuffer buffer, int version)
buffer - The DataBuffer into which the data should be placed.version - The version of the information to be provided.true if the operation was successful;
false otherwise.public abstract String getSyncName()
SyncCollectionSyncCollection.
NOTE: The name that is returned must be unique across all
SyncCollections.*public abstract String getSyncName(Locale locale)
SyncCollectionSyncCollection.
If this returns null, then the result from getSyncName()
will be shown instead.
*public SyncObject getSyncObject(int uid)
SyncCollectionSyncObject in this SyncCollection
with the given UID.*public int getSyncObjectCount()
SyncCollectionSyncObjects in this SyncCollection.*public SyncObject[] getSyncObjects()
SyncCollectionSyncObjects representing all
SyncObjects in this SyncCollection.
The synchronization manager assumes that it is free to manipulate this array as it requires.
*public abstract int getSyncVersion()
SyncCollectionSyncCollection.*public int getUID()
SyncObjectSyncObject.
*public boolean isSyncObjectDirty(SyncObject object)
SyncCollectionSyncObject is dirty.
"Dirty" refers to whether or not the object has been modified on the handheld.
*public boolean removeAllSyncObjects()
SyncCollectionSyncObjects from the SyncCollection.*public boolean removeSyncObject(SyncObject object)
SyncCollectionSyncObject from this SyncCollection.*public abstract boolean setSyncData(DataBuffer buffer, int version)
buffer - The data received through synchronization.version - The version number specified with the data.true if the operation was successful;
false otherwise.public void setSyncObjectDirty(SyncObject object)
SyncCollectionSyncObject as dirty.
"Dirty" refers to whether or not the object has been modified on the handheld.
*public boolean updateSyncObject(SyncObject oldObject, SyncObject newObject)
SyncCollectionSyncObject 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.
*
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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.