net.rim.device.api.synchronization
Interface SyncCollectionStatistics


public interface SyncCollectionStatistics

A collection of SyncObjects used to provide statistics on a specific SyncCollection.

Each application that supports synchronization maintains a collection of synchronized objects, with each collection identified by a unique name.

See Also:
SyncManagerStatistics, SyncCollectionStatisticsManager
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 4.0.0

Method Summary
Category: Signed  int getSyncCollectionSize()
          Obtain the flash size of a SyncCollection by summing the flash sizes of its SyncObjects.
Category: Signed  String getSyncName()
          Returns the name of this SyncCollection.
Category: Signed  int getSyncObjectCount()
          Returns the number of SyncObjects in this SyncCollection.
 



Method Detail

getSyncName

String getSyncName()
Returns the name of this SyncCollection. NOTE: The name that is returned must be unique across all SyncCollecetions.

Returns:
The name of this SyncCollection.
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 4.0.0

getSyncObjectCount

int getSyncObjectCount()
Returns the number of SyncObjects in this SyncCollection.

Returns:
The number of SyncObjects in this SyncCollection.
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 4.0.0

getSyncCollectionSize

int getSyncCollectionSize()
Obtain the flash size of a SyncCollection by summing the flash sizes of its SyncObjects.

Parameters:
syncCollection - The SyncCollection to get the flash size of.
Returns:
The sum of the flash sizes of all SyncObjects in the SyncCollection.
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 4.0.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.