| Package | com.esri.bacore |
| Class | public final class BATaskCompletedEvent |
| Inheritance | BATaskCompletedEvent  flash.events.Event |
See also
| Property | Defined by | ||
|---|---|---|---|
| messages : Array [read-only]
Array of the TaskMessage type items.
| BATaskCompletedEvent | ||
| result : * [read-only]
Task execution result.
| BATaskCompletedEvent | ||
| taskName : String [read-only]
Task name.
| BATaskCompletedEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
BATaskCompletedEvent(name:String, result:Array, messages:* = null)
Creates a new instance of the BATaskCompletedEvent class.
| BATaskCompletedEvent | ||
|
clone():Event
Creates a clone of the event.
| BATaskCompletedEvent | ||
|
toString():String
Gets the description of the event.
| BATaskCompletedEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| COMPLETE : String = "taskCompleted" [static]
The BATaskCompletedEvent.COMPLETE constant defines the value of the
type property of the event object for a taskCompleted event. | BATaskCompletedEvent | ||
| messages | property |
messages:Array [read-only]Array of the TaskMessage type items.
Implementation public function get messages():Array
See also
| result | property |
result:* [read-only]Task execution result.
Implementation public function get result():*
| taskName | property |
taskName:String [read-only]Task name.
Implementation public function get taskName():String
| BATaskCompletedEvent | () | constructor |
public function BATaskCompletedEvent(name:String, result:Array, messages:* = null)Creates a new instance of the BATaskCompletedEvent class.
Parametersname:String — Task name.
|
|
result:Array — Task result.
|
|
messages:* (default = null) |
| clone | () | method |
public override function clone():EventCreates a clone of the event.
ReturnsEvent — Shallow copy of the event.
|
| toString | () | method |
public override function toString():StringGets the description of the event.
ReturnsString — String representation of the event.
|
| COMPLETE | constant |
public static const COMPLETE:String = "taskCompleted"
The BATaskCompletedEvent.COMPLETE constant defines the value of the
type property of the event object for a taskCompleted event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
babbles | false |
cancelable | false |
currentTarget | The Object that defines the event listener that handles the event. |
target | The BATask object that dispatched the event. This is an instance of a Business Analyst task that was executed. |
taskName | Name of a Business Analyst task that was executed. |
result | Task execution result object. |
messages | Optional array of TaskMessage objects received. |
The currentTarget and target properties are
specified after the event was dispatched. A responder object passed in parameters of
a Business Analyst task execute method receives the event before it is dispatched.