SHOW Signed

net.rim.blackberry.api.pim
Interface ToDoList

All Superinterfaces:

PIMList

public interface ToDoList

extends PIMList

Represents a ToDo list containing ToDo elements.

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

A ToDoList accepts only objects that implement the ToDo interface as a parameter to PIMList.items(PIMItem)). An IllegalArgumentException will be thrown if the input parameter does not implement the ToDo interface.

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.

Since:

PDAP 1.0

See Also:

ToDo, PIMList

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

UNCATEGORIZED

Method Summary

	ToDo	createToDo() Creates a new ToDo instance.
	PIMItem	importToDo(ToDo element) Imports a ToDo into the list using a given, predefined ToDo object.
	Enumeration	items(long startDate, long endDate) Returns an enumeration containing all ToDo instances between the specified start date and end date inclusive.
	void	removeToDo(ToDo element) Removes a ToDo 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

createToDo

public ToDo createToDo()

Creates a new ToDo instance.

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

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

Returns:

A new ToDo 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.

importToDo

public PIMItem importToDo(ToDo element)

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

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

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

Parameters:

element - The ToDo object to import into the list.

Returns:

The PIMItem instance 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.

removeToDo

public void removeToDo(ToDo element)
                throws PIMException

Removes a ToDo from the list.

Parameters:

element - The ToDo to be removed from the list.

Throws:

PIMException - Thrown if an error occurs, or if the ToDo 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.

items

public Enumeration items(long startDate,
                         long endDate)
                  throws PIMException

Returns an enumeration containing all ToDo instances between the specified start date and end date inclusive.

Parameters:

startDate - The start date (in long MS format) to restrict ToDo's to.

endDate - The end date (in long MS format) to restrict ToDo's to.

Returns:

An enumeration containing all ToDo items between the two specified dates.

Throws:

PIMException - Thrown if an error occurs, or if the ToDo 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.