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 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.0.0

Field Summary
	static String	ARG_NEW Argument to open the calendar in the "New Appointment" screen
	static String	ARG_VIEW_AGENDA Argument to open the calendar in the agenda view.
	static String	ARG_VIEW_DAY Argument to open the calendar in the day view.
	static String	ARG_VIEW_DEFAULT Argument to open the calendar in the default view
	static String	ARG_VIEW_MONTH Argument to open the calendar in the month view.
	static String	ARG_VIEW_WEEK Argument to open the calendar in the week view.

Constructor Summary
	CalendarArguments() Creates a new CalendarArguments instance with default arguments.
	CalendarArguments(String arg) Creates a new CalendarArguments instance with provided arguments.
	CalendarArguments(String arg, Calendar date) Creates a new CalendarArguments instance with provided arguments.
	CalendarArguments(String arg, Event event) Creates a new CalendarArguments instance with provided arguments.

Method Summary
	protected Calendar	getDateArg() Return the Calendar object used to open this Calendar to a specific date.
	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_VIEW_DAY

public static final String ARG_VIEW_DAY

Argument to open the calendar in the day view.

See Also:

Constant Field Values

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.0.0

ARG_VIEW_WEEK

public static final String ARG_VIEW_WEEK

Argument to open the calendar in the week view.

See Also:

Constant Field Values

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.0.0

ARG_VIEW_MONTH

public static final String ARG_VIEW_MONTH

Argument to open the calendar in the month view.

See Also:

Constant Field Values

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.0.0

ARG_VIEW_AGENDA

public static final String ARG_VIEW_AGENDA

Argument to open the calendar in the agenda view.

See Also:

Constant Field Values

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.0.0

ARG_VIEW_DEFAULT

public static final String ARG_VIEW_DEFAULT

Argument to open the calendar in the default view

See Also:

Constant Field Values

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.1.0

ARG_NEW

public static final String ARG_NEW

Argument to open the calendar in the "New Appointment" screen

See Also:

Constant Field Values

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.1.0

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.

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.0.0

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.

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.0.0

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

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.1.0

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

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.1.0

Method Detail

getDateArg

protected Calendar getDateArg()

Return the Calendar object used to open this Calendar to a specific date.

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.1.0

getEventArg

protected Event getEventArg()

Return the specific event used to open this Calendar to a specific event.

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.1.0