SHOW Signed
 

net.rim.blackberry.api.pdap
Interface BlackBerryContactGroup

All Superinterfaces:
PIMItem

public interface BlackBerryContactGroup
extends PIMItem

BlackBerryContactGroup items are a representation of address lists in the BlackBerry Address Book application. The objects are read-only. An attempt to call commit on a contact group will result in a PIMException being thrown.

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:
JDE 4.2.0
See Also:
ContactList, PIMItem

Field Summary
 Category: Signed static int ADDRESS_TYPE_EMAIL
          Email address type.
 Category: Signed static int ADDRESS_TYPE_PHONE
          PHONE address type.
 Category: Signed static int ADDRESS_TYPE_PIN
          PIN address type.
 Category: Signed static int NAME
          Represents the name field for an address group.
 Category: Signed static int UID
          Field specifying the UID for this address group.
 
Fields inherited from interface javax.microedition.pim.PIMItem
ATTR_NONE, BINARY, BOOLEAN, DATE, EXTENDED_ATTRIBUTE_MIN_VALUE, EXTENDED_FIELD_MIN_VALUE, INT, STRING, STRING_ARRAY
 
Method Summary
 Category: Signed  String getAddress(int index)
          Returns a String containing the the actual address at index in this BlackBerryContactGroup.
 Category: Signed  int getAddressType(int index)
          Returns the type of address at index in this BlackBerryContactGroup.
 Category: Signed  Contact getContact(int index)
          Returns a Contact object for the address at index in this BlackBerryContactGroup.
 Category: Signed  int numContacts()
          Returns the numbers of addresses in this BlackBerryContactGroup.
 
Methods inherited from interface javax.microedition.pim.PIMItem
addBinary, addBoolean, addDate, addInt, addString, addStringArray, addToCategory, commit, countValues, getAttributes, getBinary, getBoolean, getCategories, getDate, getFields, getInt, getPIMList, getString, getStringArray, isModified, maxCategories, removeFromCategory, removeValue, setBinary, setBoolean, setDate, setInt, setString, setStringArray
 

Field Detail

ADDRESS_TYPE_EMAIL

public static final int ADDRESS_TYPE_EMAIL
Email address type.
Since:
JDE 4.2.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.

ADDRESS_TYPE_PHONE

public static final int ADDRESS_TYPE_PHONE
PHONE address type.
Since:
JDE 4.2.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.

ADDRESS_TYPE_PIN

public static final int ADDRESS_TYPE_PIN
PIN address type.
Since:
JDE 4.2.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.

NAME

public static final int NAME
Represents the name field for an address group. Data associated with this field is of String type.

Since:
JDE 4.2.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.

UID

public static final int UID
Field specifying the UID for this address group. Data associated with this field is of String type.

Since:
JDE 4.2.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.
Method Detail

getAddress

public String getAddress(int index)
Returns a String containing the the actual address at index in this BlackBerryContactGroup.
Parameters:
index - an index of the desired address in the contact group.
Returns:
A String representation of the address in the contact group.
Throws:
IndexOutOfBoundsException - if the index is negative or greater than or equal to the number of values currently contained in the field.
Since:
JDE 4.2.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.

getAddressType

public int getAddressType(int index)
Returns the type of address at index in this BlackBerryContactGroup.
Parameters:
index - an index of the desired address in the contact group.
Returns:
One of ADDRESS_TYPE_EMAIL, ADDRESS_TYPE_PHONE or ADDRESS_TYPE_PIN.
Throws:
IndexOutOfBoundsException - if the index is negative or greater than or equal to the number of values currently contained in the field.
Since:
JDE 4.2.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.

getContact

public Contact getContact(int index)
Returns a Contact object for the address at index in this BlackBerryContactGroup.
Parameters:
index - an index of the desired address in the contact group.
Returns:
A Contact object representing this memeber in the contact group.
Throws:
IndexOutOfBoundsException - if the index is negative or greater than or equal to the number of values currently contained in the field.
Since:
JDE 4.2.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.

numContacts

public int numContacts()
Returns the numbers of addresses in this BlackBerryContactGroup.
Since:
JDE 4.2.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.



Copyright 1999-2009 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.