net.rim.blackberry.api.pdap
Interface BlackBerryPIMList

All Superinterfaces:
PIMList
All Known Subinterfaces:
BlackBerryContactList, BlackBerryEventList, BlackBerryMemoList, BlackBerryToDoList

public interface BlackBerryPIMList
extends PIMList

Contains the functionality for the BlackBerry-specific implementation of the PIMList.

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

Field Summary
 
Fields inherited from interface javax.microedition.pim.PIMList
UNCATEGORIZED
 
Method Summary
Category: Signed  void addListener(PIMListListener listener)
          Adds a PIM list listener to this PIM list.
Category: Signed  long getPIMListUID()
          Returns the unique identifier for this PIM list.
Category: Signed  boolean isFieldLabelSettable(int field)
          Determines whether or not a field label can be set.
Category: Signed  boolean isWirelessSyncCapable()
          Returns whether or not the this PIMList is capable of wireless synchronization with a BlackBerry Enterprise Server.
Category: Signed  boolean isWirelessSyncEnabled()
          Returns whether or not the user has enabled this PIMList for wireless synchronization with a BlackBerry Enterprise Server.
Category: Signed  void removeListener(PIMListListener listener)
          Removes a PIM list listener from this PIM list.
Category: Signed  void setFieldLabel(int field, String value)
          Sets a label for a given field.
Category: Signed  int size()
          Returns the number of items in this PIMList.
 
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

addListener

void addListener(PIMListListener listener)
Adds a PIM list listener to this PIM list.

Note that the listener will remain associated with the native device database even after the corresponding PIM list has been deleted. To remove the listener use BlackBerryPIMList.removeListener(net.rim.blackberry.api.pdap.PIMListListener). method.

Note that usage of PIMListListener3 is deprecated; however, for backwards compatibility, when a PIMListListener3 is added via this method it will be wrapped in a ListChangeListener and will still receive notifications about the default PIM list changes.

Parameters:
listener - PIM list listener to add.
Throws:
NullPointerException - if listener is null.
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

removeListener

void removeListener(PIMListListener listener)
Removes a PIM list listener from this PIM list.

Parameters:
listener - PIM list listener to remove; if null then this method does nothing and returns without throwing any exceptions.
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

setFieldLabel

void setFieldLabel(int field,
                   String value)
Sets a label for a given field.

This method silently fails if the field is invalid, or the field label for the specified field is not settable. Use BlackBerryPIMList.isFieldLabelSettable(int) method to determine if the field label is settable for this field.

Currently only the BlackBerryContact.USER1 through BlackBerryContact.USER4 fields have settable labels.

Parameters:
field - Field for which to set a label.
value - String value representing the new label for the field.
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

isFieldLabelSettable

boolean isFieldLabelSettable(int field)
Determines whether or not a field label can be set.

Parameters:
field - Field to check.
Returns:
True if the label for the provided field can be set; otherwise, false.
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

getPIMListUID

long getPIMListUID()
Returns the unique identifier for this PIM list. For details about PIMList UIDs see BlackBerryPIM.openPIMList(int, int, long).

Returns:
the unique identifier for this PIM list.
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 5.0.0

size

int size()
Returns the number of items in this PIMList.

The returned value should be used for presentation and optimization purposes only, such as a value to present to a user or an initial size for a Vector that will contain the items. For example, it should not be used as the number of elements that will be returned from the Enumeration returned from items() since items may be added to and/or removed from the list by other threads during the iteration, causing the size to be incorrect.

Returns:
the number of items in this PIMList; returns 0 if the list has been closed or the underlying PIM database has been deleted.
Throws:
SecurityException - if the application is not given permission to read the PIM list or the list is opened WRITE_ONLY.
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 5.0.0

isWirelessSyncCapable

boolean isWirelessSyncCapable()
Returns whether or not the this PIMList is capable of wireless synchronization with a BlackBerry Enterprise Server. Note that even if it is capable of wireless synchronization the user can still disable it. Use BlackBerryPIMList.isWirelessSyncEnabled() to determine if the user has disabled it.

If this PIMList is closed or the underlying PIM database has been deleted then this method returns false.

Returns:
true if this PIMList is capable of wireless synchronization; false otherwise.
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 5.0.0

isWirelessSyncEnabled

boolean isWirelessSyncEnabled()
Returns whether or not the user has enabled this PIMList for wireless synchronization with a BlackBerry Enterprise Server.

If this PIMList is closed or the underlying PIM database has been deleted then this method returns false. Also, if the PIMList is not even capable of wireless synchronization, which can be determined by BlackBerryPIMList.isWirelessSyncCapable(), then this method returns false.

Returns:
true if the user has enabled this PIMList for wireless synchronization; false otherwise.
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 5.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.