SHOW Signed

net.rim.blackberry.api.invoke
Class CalendarArguments

java.lang.Object
  |
  +--net.rim.blackberry.api.invoke.ApplicationArguments
        |
        +--net.rim.blackberry.api.invoke.CalendarArguments

public final class CalendarArguments
extends ApplicationArguments

Encapsulates arguments to pass to the Calendar application.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.0.0

Field Summary
 Category: Signed static String ARG_NEW
          Argument to open the calendar in the "New Appointment" screen
 Category: Signed protected static String ARG_VIEW
          Argument to open the calendar to view or edit an existing appointment.
 Category: Signed static String ARG_VIEW_AGENDA
          Argument to open the calendar in the agenda view.
 Category: Signed static String ARG_VIEW_DAY
          Argument to open the calendar in the day view.
 Category: Signed static String ARG_VIEW_DEFAULT
          Argument to open the calendar in the default view
 Category: Signed static String ARG_VIEW_MONTH
          Argument to open the calendar in the month view.
 Category: Signed static String ARG_VIEW_WEEK
          Argument to open the calendar in the week view.
   
Constructor Summary
 Category: Signed CalendarArguments()
          Creates a new CalendarArguments instance with default arguments.
 Category: Signed CalendarArguments(String arg)
          Creates a new CalendarArguments instance with provided arguments.
 Category: Signed CalendarArguments(String arg, Calendar date)
          Creates a new CalendarArguments instance with provided arguments.
 Category: Signed CalendarArguments(String arg, Event event)
          Creates a new CalendarArguments instance with provided arguments.
 
Method Summary
 Category: Signed protected  Calendar getDateArg()
          Return the Calendar object used to open this Calendar to a specific date.
 Category: Signed protected  Event getEventArg()
          Return the specific event used to open this Calendar to a specific event.
 
Methods inherited from class net.rim.blackberry.api.invoke.ApplicationArguments
getArgs
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ARG_NEW

public static final String ARG_NEW
Argument to open the calendar in the "New Appointment" screen
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

ARG_VIEW

protected static final String ARG_VIEW
Argument to open the calendar to view or edit an existing appointment.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

ARG_VIEW_AGENDA

public static final String ARG_VIEW_AGENDA
Argument to open the calendar in the agenda view.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

ARG_VIEW_DAY

public static final String ARG_VIEW_DAY
Argument to open the calendar in the day view.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

ARG_VIEW_DEFAULT

public static final String ARG_VIEW_DEFAULT
Argument to open the calendar in the default view
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

ARG_VIEW_MONTH

public static final String ARG_VIEW_MONTH
Argument to open the calendar in the month view.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

ARG_VIEW_WEEK

public static final String ARG_VIEW_WEEK
Argument to open the calendar in the week view.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Constructor Detail

CalendarArguments

public CalendarArguments()
Creates a new CalendarArguments instance with default arguments.

The default arguments instruct the Calendar to open in the default view.

Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CalendarArguments

public CalendarArguments(String arg)
Creates a new CalendarArguments instance with provided arguments.
Parameters:
arg - An ARG_VIEW_* When set to one of ARG_VIEW_*, opens the calendar in the specified view. When set to ARG_NEW, creates a new calendar appointment.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CalendarArguments

public CalendarArguments(String arg,
                         Calendar date)
Creates a new CalendarArguments instance with provided arguments. Used to open the Calendar to a specific date.
Parameters:
arg - When set to one of ARG_VIEW_*, opens the calendar in the specified view on the specified date. When set to ARG_NEW, creates a new calendar appointment on the specified date.
date - A Calendar object representing the date to open the Calendar to
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CalendarArguments

public CalendarArguments(String arg,
                         Event event)
Creates a new CalendarArguments instance with provided arguments. Used to open the Calendar to a specific event.
Parameters:
arg - When set to one of ARG_VIEW_*, opens the calendar in the specified view to the specified event. When set to ARG_NEW, opens the calendar ready to create a new event based on the information in the specified Event object.
event - A javax.microedition.pim.Event object representing the event to work with
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

getDateArg

protected Calendar getDateArg()
Return the Calendar object used to open this Calendar to a specific date.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getEventArg

protected Event getEventArg()
Return the specific event used to open this Calendar to a specific event.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.