| Package | org.spicefactory.lib.command.base |
| Class | public class DefaultCommandResult |
| Inheritance | DefaultCommandResult  Object |
| Implements | CommandResult |
| Property | Defined By | ||
|---|---|---|---|
| command : Object [read-only]
The command that produced the result. | DefaultCommandResult | ||
| complete : Boolean [read-only]
Whether the command completed successfully. | DefaultCommandResult | ||
| value : Object [read-only]
The actual result value. | DefaultCommandResult | ||
| Method | Defined By | ||
|---|---|---|---|
forCancellation(command:Object):CommandResult [static]
Creates a new instance for a command that has been cancelled. | DefaultCommandResult | ||
forCompletion(command:Object, result:Object):CommandResult [static]
Creates a new instance for a command that successfully completed. | DefaultCommandResult | ||
forError(command:Object, cause:Object):CommandResult [static]
Creates a new instance for a command that failed to execute. | DefaultCommandResult | ||
| command | property |
command:Object [read-only] The command that produced the result.
public function get command():Object| complete | property |
complete:Boolean [read-only] Whether the command completed successfully. If this flag is false, the value property represents the error thrown or dispatched by the command.
public function get complete():Boolean| value | property |
value:Object [read-only] The actual result value.
public function get value():Object| forCancellation | () | method |
public static function forCancellation(command:Object):CommandResultCreates a new instance for a command that has been cancelled.
Parameters
command:Object — the command that has been cancelled
|
CommandResult |
| forCompletion | () | method |
public static function forCompletion(command:Object, result:Object):CommandResultCreates a new instance for a command that successfully completed.
Parameters
command:Object — the command that completed its execution
| |
result:Object — the result produced by the command
|
CommandResult |
| forError | () | method |
public static function forError(command:Object, cause:Object):CommandResultCreates a new instance for a command that failed to execute.
Parameters
command:Object — the command that failed to execute
| |
cause:Object — the cause of the error
|
CommandResult |