SHOW Signed

net.rim.blackberry.api.pim
Interface ContactList

All Superinterfaces:

PIMList

public interface ContactList

extends PIMList

Represents a list of PIM contacts. A ContactList contains Contact objects.

The PIMList.isSupportedField(int) is invoked to determine if a field (as specified by the integer argument) is supported by a ContactList. Similarly, the PIMList.getSupportedAttributes(int) method is invoked to return an integer array representing all fields supported by the list.

For more information about this class or about the personal information management (PIM) API, refer to The PDA Profile specification (JSR-000075) for the J2ME(TM) Platform.

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.

See Also:

Contact, PIMItem

Fields inherited from interface net.rim.blackberry.api.pim.PIMList

UNCATEGORIZED

Method Summary

	Contact	createContact() Creates a new Contact instance.
	Contact	importContact(Contact element) Imports a Contact into the list using a given, predefined Contact object.
	void	removeContact(Contact element) Removes a Contact from the list.

Methods inherited from interface net.rim.blackberry.api.pim.PIMList

addCategory, close, deleteCategory, getArrayElementLabel, getAttributeLabel, getCategories, getFieldDataType, getFieldLabel, getName, getSupportedArrayElements, getSupportedAttributes, getSupportedFields, isCategory, isSupportedArrayElement, isSupportedAttribute, isSupportedField, items, items, items, itemsByCategory, maxCategories, maxValues, renameCategory

Method Detail

createContact

public Contact createContact()

Creates a new Contact instance.

The new Contact object is created initially empty and contains empty fields for all attributes that are supported by the list.

The Contact object is not added to the ContactList upon creation. The method PIMItem.commit() must be invoked in order to add the Contact to the list.

Returns:

Returns a new Contact instance.

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.

importContact

public Contact importContact(Contact element)

Imports a Contact into the list using a given, predefined Contact object.

The Contact is created using as much of the existing information as possible. If a field in the existing Contact object is not supported by the ContactList, the field is not included in the Contact. If the specified Contact is already in the list, a new Contact is created with similar information.

The Contact object is not added to the ContactList upon creation. The method PIMItem.commit() must be invoked in order to add the Contact to the list.

Parameters:

element - The Contact object to use to import data into the new contact.

Returns:

The Contact object to add to the list.

Since:

JDE 3.6

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.

removeContact

public void removeContact(Contact element)
                   throws PIMException

Removes a Contact from the list.

Parameters:

element - The Contact to be removed from the list.

Throws:

PIMException - Thrown if an error occurs, or if the Contact cannot be found in the list.

Since:

JDE 3.6

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.