net.rim.blackberry.api.pim
Interface ContactList

All Superinterfaces:

PIMList

All Known Subinterfaces:

BlackBerryContactList

Deprecated. In favour of ContactList.

public interface ContactList

extends PIMList

A list containing PIM contacts (Contact objects).

Invoke isSupportedField to determine if a field (as specified by the integer argument) is supported by this contact list. Similarly, invoke getSupportedAttributes to retrieve 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.

Since:

JDE 3.6.0

See Also:

Contact, PIMItem

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

UNCATEGORIZED

Method Summary

Contact	createContact() Deprecated. Creates a new emtpy contact for this list.
Contact	importContact(Contact element) Deprecated. Imports a provided contact into this list.
void	removeContact(Contact element) Deprecated. Removes a contact from this 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, stringArraySize

Method Detail

createContact

public Contact createContact()

Deprecated.

Creates a new emtpy contact for this list.

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

Note: This method does not automatically add the newly created contact to this list. You must invoke commit on the contact to add it to this list.

Returns:

New empty contact for adding to this list.

Since:

JDE 3.6.0

importContact

public Contact importContact(Contact element)

Deprecated.

Imports a provided contact into this list.

This method creates a new contact and pupoulates it with as much of the information in the provided contact as possible. If a field in the existing contact object is not supported by this contact list, the field is not included in the created contact. If the provided contact is already in the list, a new contact is created with similar information.

Note: This method does not automatically add the newly created contact to this list. You must invoke commit on the contact to add it to this list.

Parameters:

element - Source contact to provide information for the the new contact.

Returns:

New populated contact for adding to this list.

Since:

JDE 4.0.2

removeContact

public void removeContact(Contact element)
                   throws PIMException

Deprecated.

Removes a contact from this list.

Parameters:

element - Contact to remove from this list.

Throws:

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

Since:

JDE 4.0.2