net.rim.device.api.synchronization
Class SyncCollectionSchema

java.lang.Object
  extended by net.rim.device.api.synchronization.SyncCollectionSchema

public final class SyncCollectionSchema
extends Object

Schema definition for SyncCollections.

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

Constructor Summary
Category: Signed SyncCollectionSchema()
          The SyncCollectionSchema object provides a schema for a syncCollection; providing information on SyncCollection data.
 
Method Summary
Category: Signed  int getDefaultRecordType()
          Return the default record type.
Category: Signed  int[] getKeyFieldIds(int recordType)
          Get the key field IDs for the given record type.
Category: Signed  int getRecordTypeTag()
          Return the tag value that indicates that a field contains the record type. 0 is returned if the sync collection does not contain multiple types of records.
Category: Signed  int[] getRecordTypes()
          Return an array containing the record types that have key fields registered.
Category: Signed  void setDefaultRecordType(int defaultRecordType)
          Set the default record type.
Category: Signed  void setKeyFieldIds(int recordType, int[] keyFieldIds)
          Set the key field IDs for the given record type.
Category: Signed  void setRecordTypeTag(int recordTypeTag)
          Set the tag value that indicates that a field contains the record type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

SyncCollectionSchema

public SyncCollectionSchema()
The SyncCollectionSchema object provides a schema for a syncCollection; providing information on SyncCollection data. This object can be used to perform actions like assigning a unique identifier to each record and different record type 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


Method Detail

getRecordTypeTag

public int getRecordTypeTag()
Return the tag value that indicates that a field contains the record type. 0 is returned if the sync collection does not contain multiple types of records.

Returns:
The record type tag or 0 if multiple record types do not exist.
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

setRecordTypeTag

public void setRecordTypeTag(int recordTypeTag)
Set the tag value that indicates that a field contains the record type.

Parameters:
recordTypeTag - The record type tag.
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

getDefaultRecordType

public int getDefaultRecordType()
Return the default record type.

Returns:
The default record type.
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

setDefaultRecordType

public void setDefaultRecordType(int defaultRecordType)
Set the default record type.

Parameters:
defaultRecordType - The default record type. This must not be 0.
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

getRecordTypes

public int[] getRecordTypes()
Return an array containing the record types that have key fields registered.

Returns:
An array of record types that have key fields registered.
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

getKeyFieldIds

public int[] getKeyFieldIds(int recordType)
Get the key field IDs for the given record type.

Parameters:
record - Type The record type to retrieve the key field IDs for.
Returns:
An array containing the key field IDs for the given record type. null is returned of the given record type has not been registered as containing any key fields.
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

setKeyFieldIds

public void setKeyFieldIds(int recordType,
                           int[] keyFieldIds)
Set the key field IDs for the given record type.

Parameters:
recordType - The record type to set the key field IDs for. This must not be 0.
keyFieldIds - Array containing the key field IDs for the given record type. If this array is null or empty, any key field IDs that are currently registered for the given record type will be removed.
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.