net.rim.blackberry.api.pdap
Interface BlackBerryToDoList

All Superinterfaces:

PIMList, ToDoList, BlackBerryPIMList

public interface BlackBerryToDoList
extends ToDoList, BlackBerryPIMList

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

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.6.0

Field Summary

Fields inherited from interface javax.microedition.pim.PIMList

UNCATEGORIZED

Fields inherited from interface javax.microedition.pim.PIMList

UNCATEGORIZED

Method Summary
	BlackBerryToDo	getByUID(String uid) Finds a ToDo by its UID.

Methods inherited from interface javax.microedition.pim.ToDoList

createToDo, importToDo, items, removeToDo

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

Methods inherited from interface net.rim.blackberry.api.pdap.BlackBerryPIMList

addListener, getPIMListUID, isFieldLabelSettable, isWirelessSyncCapable, isWirelessSyncEnabled, removeListener, setFieldLabel, size

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

getByUID

BlackBerryToDo getByUID(String uid)
                        throws PIMException

Finds a ToDo by its UID.

Parameters:

uid - the UID for which to search; may be null, in which case this method will behave as if the UID was not found.

Returns:

If a ToDo with the specified UID is found in this list then its ToDo object is returned; otherwise, if not found, returns null.

Throws:

PIMException - if an error occurs searching (eg. list is closed).

SecurityException - if the list was opened in a mode that does not allow reading.

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.6.0