Packagecom.rosettastone.library.taskmanager
Classpublic class StubTask
InheritanceStubTask Inheritance Task Inheritance flash.events.EventDispatcher

Empty Task useful primarily for unit testing. It can also be useful in factory situations when a default no-op behavior is desired. If certain implementations wish to provide behavior they can replace the placeholder Stub task with one that does work. This Task can be configured to auto-complete when it is executed. Otherwise it will not complete or error unless/until specifically told to do so.


Public Properties
 PropertyDefined By
 Inheriteddata : *
[read-only] Optional data parameter passed to the Task complete/error/interruption method.
Task
 Inheritedid : Number
[read-only]
Task
 Inheritedinterruptible : Boolean
[read-only] The current Task can be interrupted.
Task
 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
 InheritednumInternalOperations : int
[read-only] Number of internal operations conducted by this task.
Task
 InheritednumInternalOperationsCompleted : int
[read-only] Number of internal operations that have completed.
Task
 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
  synchronous : Boolean
[override] [read-only] The current task can be executed synchronously.
StubTask
 InheritedtaskIdentifier : String
(Optional) human-readable label for task.
Task
 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
  
StubTask(autoCompleteUponRun:Boolean = false, taskIdentifier:String = null)
Constructor.
StubTask
 Inherited
and(... chainedTasks):ITask
Executes the specified tasks when the current task is executed.
Task
  
complete(message:String, data:* = null):void
Instructs Task to complete itself.
StubTask
 Inherited
disconnectFromInterruptingTask():void
Task
  
error(message:String, data:* = null):void
Instructs Task to dispatch an error event.
StubTask
 Inherited
interrupt():Boolean
Interruptible tasks should override interrupt() and get interruptible() if they are interruptible.
Task
 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
 Inherited
customReset():void
Override this method to perform any custom reset operations.
Task
  
customRun():void
[override] Override this method to give your Task functionality.
StubTask
 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
synchronousproperty
synchronous:Boolean  [read-only] [override]

The current task can be executed synchronously.


Implementation
    public function get synchronous():Boolean
Constructor Detail
StubTask()Constructor
public function StubTask(autoCompleteUponRun:Boolean = false, taskIdentifier:String = null)

Constructor.

Parameters
autoCompleteUponRun:Boolean (default = false) — If TRUE Task will synchronously complete when it is run
 
taskIdentifier:String (default = null) — Semantically meaningful task identifier (useful for automated testing or debugging)
Method Detail
complete()method
public function complete(message:String, data:* = null):void

Instructs Task to complete itself.

Parameters

message:String
 
data:* (default = null)

customRun()method 
override protected function customRun():void

Override this method to give your Task functionality.

error()method 
public function error(message:String, data:* = null):void

Instructs Task to dispatch an error event.

Parameters

message:String
 
data:* (default = null)





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