SHOW Signed

net.rim.device.api.system
Class ApplicationManager

java.lang.Object
  |
  +--net.rim.device.api.system.ApplicationManager

public abstract class ApplicationManager
extends Object

Manages all Java applications on the device.

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 3.6.0
See Also:
Application, ApplicationDescriptor

Method Summary
 Category: Signed static ApplicationManager getApplicationManager()
          Retrieves the system's application manager.
 Category: Signed abstract  int getForegroundProcessId()
          Retrieves the process ID of the foreground process.
 Category: Signed abstract  int getProcessId(ApplicationDescriptor descriptor)
          Retrieves the process ID for specified descriptor's application.
 Category: Signed abstract  ApplicationDescriptor[] getVisibleApplications()
          Retrieves descriptors for the visible, running applications.
 Category: Signed abstract  boolean inStartup()
          Determines if the device is in the process of starting up.
 Category: Signed abstract  boolean isSystemLocked()
          Determines if the system is currently locked.
 Category: Signed abstract  void launch(String url)
          Launches an application with provided URL parameter.
 Category: Signed abstract  void lockSystem(boolean force)
          Locks the system.
 Category: Signed abstract  boolean postGlobalEvent(int processId, long guid, int data0, int data1, Object object0, Object object1)
          Posts a global event with additional data and attachments to the specified process.
 Category: Signed  boolean postGlobalEvent(long guid)
          Posts a global event to all applications in the system.
 Category: Signed  boolean postGlobalEvent(long guid, int data0, int data1)
          Posts a global event with additional data to all applications in the system.
 Category: Signed abstract  boolean postGlobalEvent(long guid, int data0, int data1, Object object0, Object object1)
          Posts a global event with additional data and attachments to all applications in the system.
 Category: Signed abstract  void requestForeground(int processId)
          Sends a foreground request to application with specified process ID.
 Category: Signed abstract  void requestForegroundForConsole()
          Requests that the console process (usually the ribbon) be notified that it should bring itself to the foreground.
 Category: Signed  int runApplication(ApplicationDescriptor descriptor)
          Creates a new process to run an application and ask it to foreground itself.
 Category: Signed abstract  int runApplication(ApplicationDescriptor descriptor, boolean grabForeground)
          Creates a new process to run an application.
 Category: Signed abstract  boolean scheduleApplication(ApplicationDescriptor descriptor, long time, boolean absolute)
          Schedules an application to run at a specific time.
 Category: Signed abstract  boolean setInHolsterInputProcess()
          Sets the invoking process to receive input events when the device is in the holster.
 Category: Signed abstract  void unlockSystem()
          Unlocks the system.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setInHolsterInputProcess

public abstract boolean setInHolsterInputProcess()
Sets the invoking process to receive input events when the device is in the holster.
Returns:
True if the invocation was successful; false if there is already another in-holster process set.
Since:
JDE 3.6.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.

launch

public abstract void launch(String url)
                     throws ApplicationManagerException
Launches an application with provided URL parameter.

This method launches an application with an URL of the following form:
module.name?param¶m¶m...
or
module?param¶m¶m...
if there is only a single entry point in the module.

Parameters:
url - URL which can be in any form and is passed in the arguments to main.
Throws:
ApplicationManagerException - If the application could not be run.
Since:
JDE 4.0.2
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.

lockSystem

public abstract void lockSystem(boolean force)
Locks the system.
Parameters:
force - If true, force the system to be locked even if security is disabled. This is used when the IT Policy changes.
Since:
JDE 4.0.2
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.

isSystemLocked

public abstract boolean isSystemLocked()
Determines if the system is currently locked.
Returns:
True if the system is currently locked.
Since:
JDE 3.6.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.

unlockSystem

public abstract void unlockSystem()
Unlocks the system.

Calling this method blocks until the system actually unlocks.

Since:
JDE 3.6.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.

runApplication

public final int runApplication(ApplicationDescriptor descriptor)
                         throws ApplicationManagerException
Creates a new process to run an application and ask it to foreground itself.

Invoke this method to create a new process and invoke the exported main() method in the specified descriptor. This method then asks the process to foreground itself (which it may or may not do). If a process has already been created for your descriptor, then this method sends that process a foreground request.

Parameters:
descriptor - Descriptor of application to start.
Returns:
Process ID for the application's new process; if the application already has a running process, this will be the ID for that process.
Throws:
ApplicationManagerException - Thrown if the application could not be run.
Since:
JDE 4.0.2
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.

runApplication

public abstract int runApplication(ApplicationDescriptor descriptor,
                                   boolean grabForeground)
                            throws ApplicationManagerException
Creates a new process to run an application.

Invoke this method to create a new process and invoke the exported main() method in the specified descriptor. If you pass true for the grabForeground parameter, then this method also asks the process to foreground itself (which it may or may not do). If a process has already been created for your descriptor, and you pass true for the grabForeground parameter, then this method sends that process a foreground request.

Parameters:
descriptor - Descriptor of application to start.
grabForeground - If true, this method prompts the application to foreground itself.
Returns:
Process ID for the application's new process; if the application already has a running process, this will be the ID for that process.
Throws:
ApplicationManagerException - Thrown if the application could not be run.
Since:
JDE 4.0.2
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.

scheduleApplication

public abstract boolean scheduleApplication(ApplicationDescriptor descriptor,
                                            long time,
                                            boolean absolute)
Schedules an application to run at a specific time.

If the application is already scheduled to run at a particular time, then this method updates the schedule with your specified time. Note that the application scheduler has a resolution of one minute. Times are rounded down to the nearest minute.

If the specified time is absolute and has already occurred, the application will not be scheduled.

Parameters:
descriptor - Descriptor of application to start.
time - Time at which to run the application; if a negative value, remove this application from the schedule.
absolute - If true, then the time parameter represents the number of milliseconds since device's origin time (midnight, January 1, 1970 UTC); otherwise, it represents the number of milliseconds since midnight local time.
Returns:
True if the application was scheduled successfully; otherwise, false.
Since:
JDE 4.0.2
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.

requestForeground

public abstract void requestForeground(int processId)
Sends a foreground request to application with specified process ID.
Parameters:
processId - Process ID for the application to receive a foreground request.
Since:
JDE 4.0.2
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.

requestForegroundForConsole

public abstract void requestForegroundForConsole()
Requests that the console process (usually the ribbon) be notified that it should bring itself to the foreground.
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.

getProcessId

public abstract int getProcessId(ApplicationDescriptor descriptor)
Retrieves the process ID for specified descriptor's application.
Parameters:
descriptor - Descriptor for the application in question.
Returns:
ID for process hosting descriptor's application; -1 if application has no process (i.e. is not running).
Since:
JDE 4.0.2
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.

getForegroundProcessId

public abstract int getForegroundProcessId()
Retrieves the process ID of the foreground process.
Parameters:
processId - Process ID of the application which is currently in the foreground; -1 if there is no foreground application.
Since:
JDE 3.6.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.

getVisibleApplications

public abstract ApplicationDescriptor[] getVisibleApplications()
Retrieves descriptors for the visible, running applications.
Returns:
Array of descriptors for the visible (foregroundable), running applications.
Since:
JDE 3.6.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.

postGlobalEvent

public final boolean postGlobalEvent(long guid)
Posts a global event to all applications in the system.

To receive and handle such events, an application must register a GlobalEventListener.

Parameters:
guid - The GUID of the event.
Returns:
True if the event was successfully posted; otherwise, false.
Since:
JDE 4.0.2
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.

postGlobalEvent

public final boolean postGlobalEvent(long guid,
                                     int data0,
                                     int data1)
Posts a global event with additional data to all applications in the system.

To receive and handle such events, an application must register a GlobalEventListener.

Parameters:
guid - The GUID of the event.
data0 - Additional information associated with the event.
data1 - Additional information associated with the event.
Returns:
True if the event was successfully posted; otherwise, false.
Since:
JDE 4.0.2
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.

postGlobalEvent

public abstract boolean postGlobalEvent(long guid,
                                        int data0,
                                        int data1,
                                        Object object0,
                                        Object object1)
Posts a global event with additional data and attachments to all applications in the system.

To receive and handle such events, an application must register a GlobalEventListener.

Parameters:
guid - The GUID of the event.
data0 - Additional information associated with the event.
data1 - Additional information associated with the event.
object0 - Additional information associated with the event.
object1 - Additional information associated with the event.
Returns:
True if the event was successfully posted; otherwise, false.
Since:
JDE 4.0.2
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.

postGlobalEvent

public abstract boolean postGlobalEvent(int processId,
                                        long guid,
                                        int data0,
                                        int data1,
                                        Object object0,
                                        Object object1)
Posts a global event with additional data and attachments to the specified process.

To receive and handle such events, the application must register a GlobalEventListener.

Parameters:
processId - Process ID of the application to receive the event.
guid - The GUID of the event.
data0 - Additional information associated with the event.
data1 - Additional information associated with the event.
object0 - Additional information associated with the event.
object1 - Additional information associated with the event.
Returns:
True if the event was successfully posted; otherwise, false.
Since:
JDE 4.0.2
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.

inStartup

public abstract boolean inStartup()
Determines if the device is in the process of starting up. During startup, all threads must quiesce in order for the startup process to move on to the next startup tier.
Returns:
True if the device is in the process of starting up.
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.

getApplicationManager

public static final ApplicationManager getApplicationManager()
Retrieves the system's application manager.
Returns:
Reference to the system's application manager.
Since:
JDE 3.6.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-2004 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.