net.rim.device.api.command.registrar
Class RemoteCommandRegistrarConnection

java.lang.Object
  net.rim.device.api.command.registrar.RemoteCommandRegistrarConnection

All Implemented Interfaces:

CommandRegistrarConnection

public class RemoteCommandRegistrarConnection
extends Object
implements CommandRegistrarConnection

Interacts with the command registrar that is available to all processes.

Since:

BlackBerry API 6.0.0

Constructor Summary

RemoteCommandRegistrarConnection()
Creates a RemoteCommandRegistrarConnection instance.

Method Summary
Command	getCommand(CommandRequest request) Returns a Command instance that matches specified criteria.
Command[]	getCommands(CommandRequest request) Returns an array of Command instances that match specified criteria.
Command[]	getCommands(CommandRequest request, int maximumNumberOfCommands) Returns an array of Command instances that match specified criteria.
void	registerCommand(CommandHandler handler, CommandMetadata metadata) Registers a command using its command handler and associated metadata.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteCommandRegistrarConnection

public RemoteCommandRegistrarConnection()

Creates a RemoteCommandRegistrarConnection instance.

Since:

BlackBerry API 6.0.0

Method Detail

getCommand

public Command getCommand(CommandRequest request)

Returns a Command instance that matches specified criteria.

Specified by:

getCommand in interface CommandRegistrarConnection

Parameters:

request - Criteria used to obtain commands.

Returns:

Command instance that matches the criteria. Only one instance is returned even if there are multiple matches. Returns null if there are no matching commands.

Since:

BlackBerry API 6.0.0

getCommands

public Command[] getCommands(CommandRequest request)

Returns an array of Command instances that match specified criteria.

Specified by:

getCommands in interface CommandRegistrarConnection

Parameters:

request - Criteria used to obtain commands.

Returns:

Command instances that match the criteria. Returns an empty array if no matches are found.

Since:

BlackBerry API 6.0.0

getCommands

public Command[] getCommands(CommandRequest request,
                             int maximumNumberOfCommands)

Returns an array of Command instances that match specified criteria.

Specified by:

getCommands in interface CommandRegistrarConnection

Parameters:

request - Criteria used to obtain commands.

maximumNumberOfCommands - Maximum number of commands to return.

Returns:

Command instances that match the criteria. Returns an empty array if no matches are found.

Since:

BlackBerry API 6.0.0

registerCommand

public void registerCommand(CommandHandler handler,
                            CommandMetadata metadata)

Registers a command using its command handler and associated metadata.

Specified by:

registerCommand in interface CommandRegistrarConnection

Parameters:

handler - The command handler.

metadata - The command metadata.

Throws:

RegistrationException - If metadata is null or metadata with same id has already been registered.

Since:

BlackBerry API 6.0.0