BlackBerryMemoList (BlackBerry JDE 6.0.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 BlackBerryMemoList

All Superinterfaces:: PIMList, BlackBerryPIMList

public interface BlackBerryMemoList
extends BlackBerryPIMList
extends BlackBerryPIMList

Represents the default RIM BlackBerryMemo database.

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

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

Working with the BlackBerryMemoList object

The following examples demonstrate how to use the BlackBerryMemoList object.

Below, the memo list is retrieved in read/write mode.

         PIM p = PIM.getInstance();
         BlackBerryMemoList memoList;
         try {
             memoList = (BlackBerryMemoList) p.openPIMList( BlackBerryPIM.MEMO_LIST, BlackBerryPIM.READ_WRITE );
         } catch ( PIMException e ) {
             // BlackBerryMemoList could not be opened...
         }

Adding BlackBerryMemos to the BlackBerryMemoList

The following example shows how to create a new, empty BlackBerryMemo that is associated with the BlackBerryMemoList.

         BlackBerryMemo memo = memoList.createMemo();

This next example demonstrates how to import data from a BlackBerryMemo into a new BlackBerryMemo that is associated with the BlackBerryMemoList.

         BlackBerryMemo memo = memoList.importMemo( inputMemo );

In both of the above examples, the newly-created memo has not been saved to the BlackBerryMemoList. In order to save the memo, the PIMItem.commit() method must be invoked.

Removing BlackBerryMemos from the BlackBerryMemoList

The following example shows how to remove a BlackBerryMemo from the BlackBerryMemoList.

         try {
             memoList.removeMemo( memo );
         } catch ( PIMException e ) {
             // memo couldn't be found in the list
         }

Retrieving BlackBerryMemos from the BlackBerryMemoList

Methods are provided for retrieving a complete listing of the BlackBerryMemos in the list, or retrieving only those BlackBerryMemos that meet certain criteria. The following examples demonstrate how to use them.

To retrieve all BlackBerryMemos from the list, invoke the PIMList.items() method.

         try {
             Enumeration memos = memoList.items();
         } catch ( PIMException e ) {
             // list has already been closed
         }

To retrieve all BlackBerryMemos that match the data of another BlackBerryMemo, invoke the PIMList.items(PIMItem) method. Note that the argument must be an object that implements the BlackBerryMemo interface.

         try {
             Enumeration memos = memoList.items( memo );
         } catch ( PIMException e ) {
             // list has already been closed
         }

Finally, to retrieve all BlackBerryMemos that match the contents of a String, invoke the PIMList.items(String) method.

         try {
             Enumeration memos = memoList.items( "Company Policy" );
         } catch ( PIMException e ) {
             // list has already been closed
         }

Accessing the MemoPad database

This interface allows developers to manipulate the "memos" database: the database used by the BlackBerry MemoPad application. Use an implementation of this interface to add, remove, or update memos in an application. Modifications to the memo database are visible through the MemoPad application. Listeners can be registered to notify an application when the memo database is modified. Changes to the MemoPad database through this interface are synchronized wirelessly with the client’s Outlook/Notes server.

For more information about the personal information management (PIM) API, refer to The PDA Profile specification (JSR-000075) for the J2ME(TM) Platform.

See Also:: PIMList, BlackBerryMemo
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

Fields inherited from interface javax.microedition.pim.PIMList
`UNCATEGORIZED`

Method Summary
	`BlackBerryMemo`	`createMemo()` Creates a new `BlackBerryMemo` instance.
	`BlackBerryMemo`	`getByUID(String uid)` Finds a memo by its UID.
	`BlackBerryMemo`	`importMemo(BlackBerryMemo element)` Imports a `BlackBerryMemo` into the list using a given, predefined `BlackBerryMemo` object.
	`void`	`removeMemo(BlackBerryMemo element)` Removes a `BlackBerryMemo` from the list.

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

createMemo

BlackBerryMemo createMemo()

Creates a new BlackBerryMemo instance.

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

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

Returns:: A new BlackBerryMemo instance.
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

importMemo

BlackBerryMemo importMemo(BlackBerryMemo element)

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

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