net.rim.blackberry.api.pdap
Interface BlackBerryContactList

All Superinterfaces:

ContactList, PIMList

public interface BlackBerryContactList

extends ContactList

Contains the functionality for the BlackBerry-specific implementation of a ContactList.

Since:

JDE 4.0.0

Inner Class Summary

static interface

BlackBerryContactList.AddressTypes Describes the various address types supported by the choose(javax.microedition.pim.Contact, int, boolean) method.

Fields inherited from interface javax.microedition.pim.PIMList

UNCATEGORIZED

Method Summary

Contact	choose(Contact previous, int type, boolean allowCrossService) Launches the address book so that the user can pick an address.
void	lookup(Contact matching, RemoteLookupListener listener) Initiates a remote lookup.
void	lookup(String matching, RemoteLookupListener listener) Initiates a remote lookup.

Methods inherited from interface javax.microedition.pim.ContactList

createContact, importContact, removeContact

Methods inherited from interface javax.microedition.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

lookup

public void lookup(String matching,
                   RemoteLookupListener listener)
            throws IllegalArgumentException

Initiates a remote lookup.

The results are passed to your provided RemoteLookupListener's items method.

Parameters:

matching - String used for matching fields.

listener - Remote lookup listener.

Throws:

IllegalArgumentException - If you provide a bad parameter.

Since:

JDE 4.0.0

lookup

public void lookup(Contact matching,
                   RemoteLookupListener listener)
            throws IllegalArgumentException

Initiates a remote lookup.

The results are passed to your provided RemoteLookupListener's items method.

Parameters:

matching - Contact used for matching fields.

listener - Remote lookup listener.

Throws:

IllegalArgumentException - If you provide a bad parameter.

Since:

JDE 4.0.0

choose

public Contact choose(Contact previous,
                      int type,
                      boolean allowCrossService)

Launches the address book so that the user can pick an address.

Parameters:

previous - Contact used as the starting point in the address book (may be null).

type - One of the address types defined by the BlackBerryContactList.AddressTypes interface.

allowCrossService - If true, permit selection of addresses that will use a different service (ie, BWC etc); otherwise, false.

Returns:

Contact next contact of provided type after provided starting point.

Since:

JDE 4.0.0