com.rosettastone.library.taskmanager.AbstractTaskManager

Public Properties

	Property		Defined By
		completed : Boolean [read-only] There are no pending or active Tasks.	AbstractTaskManager
		data : * [read-only] Optional data parameter passed to the Task complete/error/interruption method.	Task
		errorDatas : Array [read-only] Error datas from all inner Tasks that failed during execution.	AbstractTaskManager
		erroredTasks : Array [read-only] Tasks that errored during execution.	AbstractTaskManager
		errorMessages : Array [read-only] Unique error messages from all inner Tasks that failed during execution.	AbstractTaskManager
		id : Number [read-only]	Task
		interruptible : Boolean [override] [read-only] The current Task can be interrupted.	AbstractTaskManager
		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
		numCompletedTasks : int [read-only] Number of Tasks that have successfully completed execution.	AbstractTaskManager
		numInternalOperations : int [override] [read-only] Number of internal operations conducted by this task.	AbstractTaskManager
		numInternalOperationsCompleted : int [override] [read-only] Number of internal operations that have completed.	AbstractTaskManager
		numInternalOperationsPending : int [read-only] Number of internal operations not yet completed.	Task
		numTasks : int [read-only] Number of Tasks to be executed by TaskManager.	AbstractTaskManager
		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.	AbstractTaskManager
		taskIdentifier : String (Optional) human-readable label for task.	Task
		uniqueID : Number [read-only] Unique ID for a task.	Task

	Property	Defined By
		logger : ILogger [read-only] Instance of ILogger to be used for any custom Task logging.	Task

	Method	Defined By
		and(... chainedTasks):ITask Executes the specified tasks when the current task is executed.	Task
		disconnectFromInterruptingTask():void	Task
		interrupt():Boolean [override] Interruptible tasks should override interrupt() and get interruptible() if they are interruptible.	AbstractTaskManager
		interruptForTask(interruptingTask:ITask):Boolean Interrupts the current Task to wait on the Task specified.	Task
		or(... chainedTasks):ITask Executes the specified tasks if the current task fails.	Task
		reset():void Resets the task to it's pre-run state.	Task
		run():ITask Starts a task.	Task
		then(... chainedTasks):ITask 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
		addTaskHelper(task:ITask, dependencies:Array = null):void Adds a task to the graph and set its dependencies.	AbstractTaskManager
		customReset():void [override] Override this method to perform any custom reset operations.	AbstractTaskManager
		customRun():void [override] Override this method to give your Task functionality.	AbstractTaskManager
		dispatchProgressEvent():void	Task
		getLoggerString(string:String):String Returns a string for logging the specified task-state event.	Task
		removeTaskHelper(taskToRemove:ITask):void Removes a task from the task manager.	AbstractTaskManager
		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

Property Detail

completed

property

completed:Boolean [read-only]

There are no pending or active Tasks.

Implementation
public function get completed():Boolean

errorDatas

property

errorDatas:Array [read-only]

Error datas from all inner Tasks that failed during execution.

Implementation
public function get errorDatas():Array

erroredTasks

property

erroredTasks:Array [read-only]

Tasks that errored during execution.

Implementation
public function get erroredTasks():Array

errorMessages

property

errorMessages:Array [read-only]

Unique error messages from all inner Tasks that failed during execution.

Implementation
public function get errorMessages():Array

interruptible

property

interruptible:Boolean [read-only] [override]

The current Task can be interrupted. Invoking interrupt() for a Task that is not marked as interruptible may result in an error.

Implementation
public function get interruptible():Boolean

numCompletedTasks

property

numCompletedTasks:int [read-only]

Number of Tasks that have successfully completed execution.

Implementation
public function get numCompletedTasks():int

numInternalOperations

property

numInternalOperations:int [read-only] [override]

Number of internal operations conducted by this task. Sub-classes should override this method if containing a value > 1; If value > 1, task should dispatch ProgressEvent.PROGRESS events manually to indicate changes in numInternalOperationsCompleted. If value == 1, task will automatically dispatching ProgressEvent.PROGRESS events.

Implementation
public function get numInternalOperations():int

numInternalOperationsCompleted

property

numInternalOperationsCompleted:int [read-only] [override]

Number of internal operations that have completed. Sub-classes should override this method if containing a value > 1;

Implementation
public function get numInternalOperationsCompleted():int

numTasks

property

numTasks:int [read-only]

Number of Tasks to be executed by TaskManager.

Implementation
public function get numTasks():int

synchronous

property

synchronous:Boolean [read-only] [override]

The current task can be executed synchronously.

Implementation
public function get synchronous():Boolean

Method Detail

addTaskHelper

()

method

protected function addTaskHelper(task:ITask, dependencies:Array = null):void

Adds a task to the graph and set its dependencies. If TaskManager is currently running and the specified Taks has invalid dependencies, an ERROR event will be dispatched immediately.

Parameters

	`task:ITask` — Task to add to TaskManager

	`dependencies:Array` (default = `null`) — Array of Tasks that newly added Task depends on

Throws

Error — if TaskManager has been configured for interruptible-mode and Task is not either interruptible or synchronous

customReset

()

method

override protected function customReset():void

Override this method to perform any custom reset operations.

customRun

()

method

override protected function customRun():void

Override this method to give your Task functionality.

interrupt

()

method

override public function interrupt():Boolean

Interruptible tasks should override interrupt() and get interruptible() if they are interruptible. If they are, they should fire a TaskEvent.INTERRUPTED to indicate successful interruption of the task. If the interrupting fails at runtime, this method returns false

Returns

Boolean

removeTaskHelper

()

method

protected function removeTaskHelper(taskToRemove:ITask):void

Removes a task from the task manager. If the TaskManager is running and this operation unblocks any of the remaining Tasks, they will be executed as a result of this removal.

Parameters

taskToRemove:ITask — The task to remove

Event Detail

taskManagerEventComplete

Event

Event Object Type: com.rosettastone.library.taskmanager.events.TaskManagerEvent

taskManagerEventError

Event

Event Object Type: com.rosettastone.library.taskmanager.events.TaskManagerEvent

taskManagerEventInterrupted

Event

Event Object Type: com.rosettastone.library.taskmanager.events.TaskManagerEvent

Tue Sep 24 2013, 09:21 AM -04:00

Task Manager Documentation	All Packages \| All Classes \| Index \| Frames No Frames
AbstractTaskManager	Properties \| Methods \| Events

Package	com.rosettastone.library.taskmanager
Class	public class AbstractTaskManager
Inheritance	AbstractTaskManager Task flash.events.EventDispatcher
Subclasses	InterruptibleTaskManager, TaskManager

	Event		Summary	Defined By
		progress		Task
		taskEventComplete		Task
		taskEventError		Task
		taskEventFinal		Task
		taskEventInterrupted		Task
		taskEventStarted		Task
		taskManagerEventComplete		AbstractTaskManager
		taskManagerEventError		AbstractTaskManager
		taskManagerEventInterrupted		AbstractTaskManager