Packagecom.rosettastone.library.taskmanager
Classpublic class InterruptibleDecoratorTask
InheritanceInterruptibleDecoratorTask Inheritance InterruptibleTask Inheritance Task Inheritance flash.events.EventDispatcher
Implements IDecoratorTask

Decorates a non-interruptible Task and adds interruptible-like behavior. This task does not actually stop and resume the decorated Task, But it does prevent ERROR or COMPLETE events from being dispatched when in an interrupted state. Should ERROR or COMPLETE occur while interrupted they will be re-dispatched upon resume. This Task-type also re-dispatches any ProgressEvents dispatched by the decorated Task.


Public Properties
 PropertyDefined By
 Inheriteddata : *
[read-only] Optional data parameter passed to the Task complete/error/interruption method.
Task
  decoratedTask : ITask
[read-only] Inner (decorated) Task.
InterruptibleDecoratorTask
 Inheritedid : Number
[read-only]
Task
 Inheritedinterruptible : Boolean
[override] [read-only] The current Task can be interrupted.
InterruptibleTask
 InheritedinterruptingTask : ITask
[read-only] The Task currently interrupting the composite Task's execution (or NULL if no such Task exists).
Task
 InheritedisComplete : Boolean
[read-only] The current task has successfully completed execution.
Task
 InheritedisErrored : Boolean
[read-only] The current task failed.
Task
 InheritedisInterrupted : Boolean
[read-only]
Task
 InheritedisRunning : Boolean
[read-only] The task is currently running.
Task
 Inheritedmessage : String
[read-only] Optional message parameter passed to the task complete/error/interruption method.
Task
  numInternalOperations : int
[override] [read-only] Number of internal operations conducted by this task.
InterruptibleDecoratorTask
  numInternalOperationsCompleted : int
[override] [read-only] Number of internal operations that have completed.
InterruptibleDecoratorTask
 InheritednumInternalOperationsPending : int
[read-only] Number of internal operations not yet completed.
Task
 InheritednumTimesCompleted : int
[read-only] Number of times this task has completed.
Task
 InheritednumTimesErrored : int
[read-only] Number of times this task has errored.
Task
 InheritednumTimesInterrupted : int
[read-only] Number of times this task has been interrupted.
Task
 InheritednumTimesReset : int
[read-only] Number of times this task has been reset.
Task
 InheritednumTimesStarted : int
[read-only] Number of times this task has been started.
Task
 Inheritedrunning : Boolean
[read-only] The task is currently running.
Task
 Inheritedsynchronous : Boolean
[read-only] The current task can be executed synchronously.
Task
  taskIdentifier : String
[override] (Optional) human-readable label for task.
InterruptibleDecoratorTask
 InheriteduniqueID : Number
[read-only] Unique ID for a task.
Task
Protected Properties
 PropertyDefined By
 Inheritedlogger : ILogger
[read-only] Instance of ILogger to be used for any custom Task logging.
Task
Public Methods
 MethodDefined By
  
InterruptibleDecoratorTask(decoratedTask:ITask, taskIdentifier:String = null)
InterruptibleDecoratorTask
 Inherited
and(... chainedTasks):ITask
Executes the specified tasks when the current task is executed.
Task
 Inherited
disconnectFromInterruptingTask():void
Task
 Inherited
interrupt():Boolean
[override] Interrupt the current Task.
InterruptibleTask
 Inherited
interruptForTask(interruptingTask:ITask):Boolean
Interrupts the current Task to wait on the Task specified.
Task
 Inherited
or(... chainedTasks):ITask
Executes the specified tasks if the current task fails.
Task
 Inherited
reset():void
Resets the task to it's pre-run state.
Task
 Inherited
run():ITask
Starts a task.
Task
 Inherited
then(... chainedTasks):ITask
Executes the specified tasks once the current task has completed successfully.
Task
 Inherited
withCompleteHandler(completeHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate completion, this method may also be used for notification purposes.
Task
 Inherited
withErrorHandler(errorHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate failure, this method may also be used for notification purposes.
Task
 Inherited
withFinalHandler(finalHandler:Function):ITask
This handler is invoked upon either success or failure of the Task.
Task
 Inherited
withInterruptionHandler(interruptionHandler:Function):ITask
Task
 Inherited
withStartedHandler(startedHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate starting, this method may also be used for notification purposes.
Task
Protected Methods
 MethodDefined By
  
customInterrupt():void
[override] Sub-classes should override this method to implement interruption behavior (removing event listeners, pausing objects, etc.).
InterruptibleDecoratorTask
  
customReset():void
[override] Override this method to perform any custom reset operations.
InterruptibleDecoratorTask
  
customRun():void
[override] Override this method to give your Task functionality.
InterruptibleDecoratorTask
 Inherited
dispatchProgressEvent():void
Task
 Inherited
getLoggerString(string:String):String
Returns a string for logging the specified task-state event.
Task
 Inherited
taskComplete(message:String, data:* = null):void
This method should be called upon Task completion.
Task
 Inherited
taskError(message:String, data:* = null):void
This method should be called upon Task failure.
Task
 Inherited
taskInterrupted(message:String, data:* = null):void
Call this method to interrupt the currently running Task.
Task
 Inherited
throwErrorIfAnyObjectInArrayIsNotATask(tasks:Array):void
Task
Events
 Event Summary Defined By
 Inherited
progress
Task
 Inherited
taskEventComplete
Task
 Inherited
taskEventError
Task
 Inherited
taskEventFinal
Task
 Inherited
taskEventInterrupted
Task
 Inherited
taskEventStarted
Task
Property Detail
decoratedTaskproperty
decoratedTask:ITask  [read-only]

Inner (decorated) Task.


Implementation
    public function get decoratedTask():ITask
numInternalOperationsproperty 
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
numInternalOperationsCompletedproperty 
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
taskIdentifierproperty 
taskIdentifier:String[override]

(Optional) human-readable label for task.


Implementation
    public function get taskIdentifier():String
    public function set taskIdentifier(value:String):void
Constructor Detail
InterruptibleDecoratorTask()Constructor
public function InterruptibleDecoratorTask(decoratedTask:ITask, taskIdentifier:String = null)



Parameters
decoratedTask:ITask
 
taskIdentifier:String (default = null)
Method Detail
customInterrupt()method
override protected function customInterrupt():void

Sub-classes should override this method to implement interruption behavior (removing event listeners, pausing objects, etc.).

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.





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