| Package | com.mi.rs |
| Interface | public interface IBatchCommand extends ICommand |
| Implementors | BatchCommand |
Interface specifying a batch command. A batch command is a special command that can have any number of sub-commands. The batch command is processed as a single command and gets only a single reply from the server. The sub-commands can't have individual response handlers, but the IResponse interface has helper methods that makes it easier to process the sub-command results of a batch command.
Batch commands can be nested, meaning that a batch command can have sub-commands that are in turn batch commands and so on. Batch commands can not contain commands that return binary data such as the "render" command.
| Property | Defined By | ||
|---|---|---|---|
|
commands : Array [read-only]
The array containing the sub-commands of this batch command.
|
IBatchCommand | ||
|
continueOnError : Boolean [read-only]
Defines the error mode of this batch command.
|
IBatchCommand | ||
 |
isCancelled : Boolean [read-only]
This property is set to true by the implementing class if the
command has been cancelled, in which case it will simply be
skipped by the service.
|
ICommand | |
|
name : String [read-only]
The name of the RealityServer command to call.
|
ICommand | |
|
params : Object [read-only]
An associative array containing the command arguments as
name/value pairs.
|
ICommand | |
| Method | Defined By | ||
|---|---|---|---|
|
addCommand(cmd:ICommand):void
Adds a command to the batch.
|
IBatchCommand | ||
| commands | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescommands:Array [read-only]
The array containing the sub-commands of this batch command.
public function get commands():Array| continueOnError | property |
continueOnError:Boolean [read-only]
Defines the error mode of this batch command. If true all commands in the batch will be processed regardless of if previous commands has failed. If false, the processing will halt at the first error.
public function get continueOnError():Boolean| addCommand | () | method |
public function addCommand(cmd:ICommand):void
Adds a command to the batch. Batch sub-commands will be processed in the same order they are added and their responses can be accessed from the Response object passed to a response handler of the batch command itself.
Parameters
cmd:ICommand — The command to add as a sub-command.
|