javaextensions/pim/javasrc/com/nokia/mj/impl/pim/Calendar.java
author hgs
Thu, 02 Sep 2010 13:22:59 +0300
changeset 67 63b81d807542
permissions -rw-r--r--
v2.2.13_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
67
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     1
/*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     3
* All rights reserved.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     8
*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    11
*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    12
* Contributors:
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    13
*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    14
* Description:  Abstract PIMExtension class.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    15
 *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    16
*/
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    17
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    18
// PACKAGE
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    19
package com.nokia.mj.impl.pim;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    20
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    21
// CLASS DEFINITION
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    22
/**
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    23
 * <p>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    24
 * Nokia propritery class for holding the calendar file name and calendar display name.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    25
 * </p>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    26
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    27
 * <h3>General</h3>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    28
 * The object of the class will be returned to user when listcalendars is called from the MIDlet.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    29
 * Using the object user can obtain either calendar file name or calendar display name. These names should be used in appropriate places.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    30
 * <ul>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    31
 * <li>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    32
 * <h3>Sample MIDlet code snippet</h3>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    33
 *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    34
 * <h4>Opening a Memo List from a calendar name Personal available on C drive</h4>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    35
 *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    36
 * <code>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    37
 * import javax.microedition.pim.*; <br>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    38
 * import com.nokia.mid.pimextension.PIMExtension; <br>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    39
 * import com.nokia.mid.pimextension.calendar;<br>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    40
 * <pre>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    41
 *     ...
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    42
 *     // Gets a PIMExtended class instance
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    43
 *     PIM pim = PIM.getInstance();
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    44
 *     try {
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    45
 *     PIMExtension pimExtension = (PIMExtension) pim;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    46
 *     }
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    47
 *     catch (ClassCastException e){
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    48
 *     // extension is not avaialable
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    49
 *     }
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    50
 *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    51
 *     // Gets the list of calendars available on the device
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    52
 *     calendar[] calList = pimExtension.listCalendars();
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    53
 *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    54
 *     // Opens the memo list from the "Personal" calendar
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    55
 *     EventList memoList = ( EventList )
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    56
 *         calPIM.openPIMList(PIM.EVENT_LIST, PIM.READ_WRITE, "Memos", calList.getCalendarFileName);
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    57
 *  ...
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    58
 *  </pre>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    59
 * </code>
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    60
 */
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    61
public final class Calendar
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    62
{
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    63
    /*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    64
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    65
    * two strings to hold calendar File Name and Calendar name. These should not be accesible, hence they are private.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    66
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    67
    */
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    68
    private String calendarFileName;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    69
    private String calendarName;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    70
    /*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    71
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    72
    *constructor accessed by jrt implementation to construct the object with the 2 different names of the calendar.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    73
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    74
    */
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    75
    public Calendar(String fileName, String userName)
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    76
    {
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    77
        calendarFileName = fileName;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    78
        calendarName = userName;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    79
    }
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    80
    /*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    81
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    82
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    83
    * This functions getCalendarFileName() returns the calendar file name in the database.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    84
    * This string should be passed to all the operations on calendar.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    85
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    86
    */
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    87
    public String getCalendarFileName()
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    88
    {
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    89
        return calendarFileName;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    90
    }
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    91
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    92
    /*
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    93
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    94
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    95
    * This functions getCalendarName() returns the display name of the calendar.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    96
    * This should be used for user display purposes.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    97
    * Note: When user creates a calendar from java side, both the names will be same.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    98
    * The file created will be named as the string passed by user.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
    99
    * The calendar will also be named with the string.
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   100
    *
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   101
    */
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   102
    public String getCalendarName()
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   103
    {
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   104
        return calendarName;
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   105
    }
63b81d807542 v2.2.13_1
hgs
parents:
diff changeset
   106
}