BlackBerryToDo (BlackBerry JDE 7.1.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.blackberry.api.pdap
Interface BlackBerryToDo

All Superinterfaces:: PIMItem, ToDo

public interface BlackBerryToDo
extends ToDo
extends ToDo

Represents a to-do item contained in the default RIM to-do list.

See Also:: ToDo, PIMItem
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.2.0

Field Summary
	`static int`	`REMINDER` Represents the date and time that this ToDo's reminder will be fired.
	`static int`	`STATUS` Represents the completion status of this ToDo.
	`static int`	`STATUS_COMPLETED` Constant indicating the status of this event is completed.
	`static int`	`STATUS_DEFERRED` Constant indicating the status of this event is deferred.
	`static int`	`STATUS_IN_PROGRESS` Constant indicating the status of this event is in progress.
	`static int`	`STATUS_NOT_STARTED` Constant indicating the status of this event is not started.
	`static int`	`STATUS_WAITING` Constant indicating the status of this event is waiting.

Fields inherited from interface javax.microedition.pim.ToDo
`CLASS, CLASS_CONFIDENTIAL, CLASS_PRIVATE, CLASS_PUBLIC, COMPLETED, COMPLETION_DATE, DUE, NOTE, PRIORITY, REVISION, SUMMARY, UID`

Fields inherited from interface javax.microedition.pim.PIMItem
`ATTR_NONE, BINARY, BOOLEAN, DATE, EXTENDED_ATTRIBUTE_MIN_VALUE, EXTENDED_FIELD_MIN_VALUE, INT, STRING, STRING_ARRAY`

Method Summary
	`RepeatRule`	`getRepeat()` Returns a `RepeatRule` object specifying how often and when this todo occurs.
	`void`	`setRepeat(RepeatRule value)` Sets the `RepeatRule` specifying how often and when this todo occurs.

Methods inherited from interface javax.microedition.pim.PIMItem
`addBinary, addBoolean, addDate, addInt, addString, addStringArray, addToCategory, commit, countValues, getAttributes, getBinary, getBoolean, getCategories, getDate, getFields, getInt, getPIMList, getString, getStringArray, isModified, maxCategories, removeFromCategory, removeValue, setBinary, setBoolean, setDate, setInt, setString, setStringArray`

Field Detail

REMINDER

static final int REMINDER

Represents the date and time that this ToDo's reminder will be fired.

This field is of type Date.

See Also:: Constant Field Values
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.3.0

STATUS

static final int STATUS

Represents the completion status of this ToDo.

This field is of type Int.

See Also:: Constant Field Values
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.5.0

STATUS_NOT_STARTED

static final int STATUS_NOT_STARTED

Constant indicating the status of this event is not started.

See Also:: Constant Field Values
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.5.0

STATUS_IN_PROGRESS

static final int STATUS_IN_PROGRESS

Constant indicating the status of this event is in progress.

See Also:: Constant Field Values
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.5.0

STATUS_COMPLETED

static final int STATUS_COMPLETED

Constant indicating the status of this event is completed.

See Also:: Constant Field Values
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.5.0

STATUS_WAITING

static final int STATUS_WAITING

Constant indicating the status of this event is waiting.

See Also:: Constant Field Values
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.5.0

STATUS_DEFERRED

static final int STATUS_DEFERRED

Constant indicating the status of this event is deferred.

See Also:: Constant Field Values
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.5.0

Method Detail

getRepeat

RepeatRule getRepeat()

Returns a RepeatRule object specifying how often and when this todo occurs.

Returns:: The RepeatRule object describing how often this ToDo occurs or null if a RepeatRule has not been set.
See Also:: BlackBerryToDo.setRepeat(javax.microedition.pim.RepeatRule)
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.2.0

setRepeat

void setRepeat(RepeatRule value)

Sets the RepeatRule specifying how often and when this todo occurs.

Parameters:: value - A RepeatRule object describing how often this ToDo occurs or null to clear any RepeatRule.
See Also:: BlackBerryToDo.getRepeat()
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.2.0