Package | com.rosettastone.library.taskmanager |
Class | public class TaskWithClosure |
Inheritance | TaskWithClosure ![]() ![]() |
Subclasses | SynchronousTaskWithClosure |
Property | Defined By | ||
---|---|---|---|
autoCompleteAfterRunningFunction : Boolean
If TRUE this Task will synchronously complete itself once it has invoked its custom run function. | TaskWithClosure | ||
customRunFunction : Function
Function to be executed when this Task is run
| TaskWithClosure | ||
![]() | data : * [read-only]
Optional data parameter passed to the Task complete/error/interruption method. | Task | |
![]() | id : Number [read-only]
| Task | |
![]() | interruptible : Boolean [read-only]
The current Task can be interrupted. | Task | |
![]() | interruptingTask : ITask [read-only]
The Task currently interrupting the composite Task's execution (or NULL if no such Task exists). | Task | |
![]() | isComplete : Boolean [read-only]
The current task has successfully completed execution. | Task | |
![]() | isErrored : Boolean [read-only]
The current task failed. | Task | |
![]() | isInterrupted : Boolean [read-only]
| Task | |
![]() | isRunning : Boolean [read-only]
The task is currently running. | Task | |
![]() | message : String [read-only]
Optional message parameter passed to the task complete/error/interruption method. | Task | |
![]() | numInternalOperations : int [read-only]
Number of internal operations conducted by this task. | Task | |
![]() | numInternalOperationsCompleted : int [read-only]
Number of internal operations that have completed. | Task | |
![]() | numInternalOperationsPending : int [read-only]
Number of internal operations not yet completed. | Task | |
![]() | numTimesCompleted : int [read-only]
Number of times this task has completed. | Task | |
![]() | numTimesErrored : int [read-only]
Number of times this task has errored. | Task | |
![]() | numTimesInterrupted : int [read-only]
Number of times this task has been interrupted. | Task | |
![]() | numTimesReset : int [read-only]
Number of times this task has been reset. | Task | |
![]() | numTimesStarted : int [read-only]
Number of times this task has been started. | Task | |
![]() | running : Boolean [read-only]
The task is currently running. | Task | |
synchronous : Boolean [override] [read-only]
The current task can be executed synchronously. | TaskWithClosure | ||
![]() | taskIdentifier : String
(Optional) human-readable label for task. | Task | |
![]() | uniqueID : Number [read-only]
Unique ID for a task. | Task |
Method | Defined By | ||
---|---|---|---|
TaskWithClosure(customRunFunction:Function = null, autoCompleteAfterRunningFunction:Boolean = false, taskIdentifier:String = null)
Constructor. | TaskWithClosure | ||
![]() |
Executes the specified tasks when the current task is executed. | Task | |
![]() | Task | ||
errorTask(message:String, data:* = null):void
Instructs Task to dispatch an error event. | TaskWithClosure | ||
finishTask(message:String, data:* = null):void
Instructs Task to complete itself. | TaskWithClosure | ||
![]() | interrupt():Boolean
Interruptible tasks should override interrupt() and get interruptible() if they are interruptible. | Task | |
![]() | interruptForTask(interruptingTask:ITask):Boolean
Interrupts the current Task to wait on the Task specified. | Task | |
![]() |
Executes the specified tasks if the current task fails. | Task | |
![]() | reset():void
Resets the task to it's pre-run state. | Task | |
![]() |
Starts a task. | Task | |
![]() |
Executes the specified tasks once the current task has completed successfully. | Task | |
![]() | withCompleteHandler(completeHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate completion, this method may also be used for notification purposes. | Task | |
![]() | withErrorHandler(errorHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate failure, this method may also be used for notification purposes. | Task | |
![]() | withFinalHandler(finalHandler:Function):ITask
This handler is invoked upon either success or failure of the Task. | Task | |
![]() | withInterruptionHandler(interruptionHandler:Function):ITask | Task | |
![]() | withStartedHandler(startedHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate starting, this method may also be used for notification purposes. | Task |
Method | Defined By | ||
---|---|---|---|
![]() | customReset():void
Override this method to perform any custom reset operations. | Task | |
customRun():void [override]
Override this method to give your Task functionality. | TaskWithClosure | ||
![]() | dispatchProgressEvent():void | Task | |
![]() | getLoggerString(string:String):String
Returns a string for logging the specified task-state event. | Task | |
![]() | taskComplete(message:String, data:* = null):void
This method should be called upon Task completion. | Task | |
![]() | taskError(message:String, data:* = null):void
This method should be called upon Task failure. | Task | |
![]() | taskInterrupted(message:String, data:* = null):void
Call this method to interrupt the currently running Task. | Task | |
![]() | throwErrorIfAnyObjectInArrayIsNotATask(tasks:Array):void | Task |
autoCompleteAfterRunningFunction | property |
autoCompleteAfterRunningFunction:Boolean
If TRUE this Task will synchronously complete itself once it has invoked its custom run function. If an error occurs during the functions execution however the Task will not dispatch a redundant complete event.
public function get autoCompleteAfterRunningFunction():Boolean
public function set autoCompleteAfterRunningFunction(value:Boolean):void
customRunFunction | property |
customRunFunction:Function
Function to be executed when this Task is run
public function get customRunFunction():Function
public function set customRunFunction(value:Function):void
synchronous | property |
synchronous:Boolean
[read-only] [override] The current task can be executed synchronously.
public function get synchronous():Boolean
TaskWithClosure | () | Constructor |
public function TaskWithClosure(customRunFunction:Function = null, autoCompleteAfterRunningFunction:Boolean = false, taskIdentifier:String = null)
Constructor.
ParameterscustomRunFunction:Function (default = null ) — Function to be executed when this Task is run
| |
autoCompleteAfterRunningFunction:Boolean (default = false ) — If TRUE this Task will complete after running custom function (unless custom function called "errorTask")
| |
taskIdentifier:String (default = null ) — Semantically meaningful task identifier (useful for automated testing or debugging)
|
customRun | () | method |
override protected function customRun():void
Override this method to give your Task functionality.
errorTask | () | method |
public function errorTask(message:String, data:* = null):void
Instructs Task to dispatch an error event.
Parameters
message:String | |
data:* (default = null )
|
finishTask | () | method |
public function finishTask(message:String, data:* = null):void
Instructs Task to complete itself.
Parameters
message:String | |
data:* (default = null )
|