net.rim.blackberry.api.pdap
Interface BlackBerryPIMItem

All Superinterfaces:

PIMItem

public interface BlackBerryPIMItem
extends PIMItem

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

See Also:

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 6.0.0

Field Summary

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
	int	commit(int flags) Persists the data in the item to its PIM list.
	boolean	isSupportedFlag(int flag) Returns whether or not a flag is supported for BlackBerryPIMItem.commit(int).

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

Method Detail

commit

int commit(int flags)
           throws PIMException

Persists the data in the item to its PIM list. As data is changed in an item through methods in PIMItem, the data is not immediately written to the underlying data storage for the list. This method commits that data to the underlying data storage for the list. Some devices may not allow categories in the item to be persisted if the categories are not in the list returned from PIMList.getCategories(). In this case the categories are dropped silently when this method is invoked (this allows data imported using PIM.fromSerialFormat(java.io.InputStream, String) to be persisted).

Also note that some field values may be altered during the commit to fit platform restrictions. A common example of this is DATE fields. If a platform does not support storing its Date values with millisecond granularity, the platform rounds down the given Date value to its nearest value supported by the platform.

Parameters:

flags - Option for the commit. Currently, the only supported flag is BlackBerryEvent.DO_NOT_NOTIFY_ATTENDEES. If this flag is used, no notification is sent to attendees if the PIMItem is a meeting (unless it is a new meeting or if invitees have been added since the last update, because invitees must be notified about the meeting in order to accept the meeting or not).

Returns:

The result of notification. A return value of either BlackBerryEvent.MEETING_RECORD_NOT_FOUND or BlackBerryEvent.INVITEE_LIST_CHANGED means that notification is sent.

Throws:

PIMException - if the commit encounters an error and cannot complete. Also thrown if the item does not belong to any list, or the list is closed or inaccessible.

SecurityException - if the application has not been granted write access to the PIM list or the list is opened PIM.READ_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 6.0.0

isSupportedFlag

boolean isSupportedFlag(int flag)

Returns whether or not a flag is supported for BlackBerryPIMItem.commit(int).

Parameters:

flag - Option flag to be validated. Currently, the only supported flag is BlackBerryEvent.DO_NOT_NOTIFY_ATTENDEES.

Returns:

boolean true if supported; 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 6.0.0