net.rim.blackberry.api.invoke
Class TaskArguments

java.lang.Object
  net.rim.blackberry.api.invoke.ApplicationArguments
      net.rim.blackberry.api.invoke.TaskArguments

public final class TaskArguments
extends ApplicationArguments

Encapsulates arguments to pass to the Task 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 Use this argument to open the Task application to create a new task
	static String	ARG_VIEW Use this argument to open the Task application to view/edit an existing task

Constructor Summary
	TaskArguments() Creates a new TaskArguments instance with default arguments.
	TaskArguments(String arg) Creates a new TaskArguments instance with one argument
	TaskArguments(String arg, ToDo todo) Creates a new TaskArguments instance with one argument and one ToDo object.

Method Summary

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

Use this argument to open the Task application to create a new task

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

ARG_VIEW

public static final String ARG_VIEW

Use this argument to open the Task application to view/edit an existing task

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

Constructor Detail

TaskArguments

public TaskArguments()

Creates a new TaskArguments instance with default arguments.

The default arguments instruct the Message application 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

TaskArguments

public TaskArguments(String arg)

Creates a new TaskArguments instance with one argument

Parameters:

arg - Specify ARG_NEW to open the Task application to create a new, blank task.

Throws:

IllegalArgumentException - if an argument other than ARG_NEW is used.

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

TaskArguments

public TaskArguments(String arg,
                     ToDo todo)

Creates a new TaskArguments instance with one argument and one ToDo object.

Parameters:

arg - Specify ARG_NEW to create a new task based on the todo arg. Specify ARG_VIEW to view/edit the existing todo arg.

todo - If ARG_NEW is specified, a new (uncommitted) ToDo object. If ARG_VIEW, an existing ToDo object.

Throws:

IllegalArgumentException - If arg is not either ARG_NEW or ARG_VIEW, if ARG_NEW is used in conjuction with a committed ToDo object, or if ARG_VIEW is used in conjunction with an uncommitted ToDo object.

RuntimeException - If BlackBerryToDoList cannot be opened or permission to open is denied.

SecurityException - If access to the PIM API is forbidden.

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