ObjectGroupingDemo.java

/*
 * ObjectGroupingDemo.java
 *
 * Copyright � 1998-2011 Research In Motion Limited
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Note: For the sake of simplicity, this sample application may not leverage
 * resource bundles and resource strings.  However, it is STRONGLY recommended
 * that application developers make use of the localization features available
 * within the BlackBerry development platform to ensure a seamless application
 * experience across a variety of languages and geographies.  For more information
 * on localizing your application, please refer to the BlackBerry Java Development
 * Environment Development Guide associated with this release.
 */

package com.rim.samples.device.objectgroupingdemo;

import net.rim.device.api.system.ObjectGroup;
import net.rim.device.api.system.ObjectGroupReadOnlyException;

/**
 * This class contains the starting point for this demo and shows how grouping
 * and ungrouping should work. As well, it shows how an exception is thrown if
 * an object is grouped and the application attempts to modify it.
 */
public class ObjectGroupingDemo {
    /**
     * Entry point for application.
     * 
     * @param args
     *            Command-line arguments (not used)
     */
    public static void main(final String[] args) {
        final AddressBook addressBook = AddressBook.getInstance();

        // Ensure we are starting with an empty address book
        addressBook.removeAll();

        // Create some sample address book entries
        final AddressBookRecord record1 =
                new AddressBookRecord("Mr.", "Clyde", "Warren");
        final AddressBookRecord record2 = new AddressBookRecord();
        record2.setTitle("Mrs.");
        record2.setFirstName("Heather");
        record2.setLastName("Tiegs");

        addressBook.add(record1);
        addressBook.add(record2);

        addressBook.remove(record2);
        addressBook.update(record1, record2);

        // Ensure that the size of the address book is correct
        if (addressBook.size() != 1) {
            throw new RuntimeException(); // We should only have one record left
        }

        // Now, try to update a record entry from the address book directly
        // without ungrouping
        final AddressBookRecord myRecord = addressBook.getRecord(0);

        // Show that myRecord is currently in a group
        final boolean isGrouped = ObjectGroup.isInGroup(myRecord);
        System.out.println("Object is grouped? " + isGrouped);

        // Try to update the record and catch the resulting exception.
        try {
            myRecord.setFirstName("");
        } catch (final ObjectGroupReadOnlyException e) {
            System.out
                    .println("ObjectGroupReadOnlyException caught as expected: "
                            + e);
        }

        // Clear up the address book to remove remaining entries
        addressBook.remove(myRecord);
    }
}