Status

A Status object describes the status of a workfow, task, trigger, group, edge or sequence. A workflow log is an orderd collection of Status that tells the story of the workflow's execution.

Instance Methods

getDescription() → String

Returns a description, if any, associated with this status

Returns: String - The description.

getThread() → String

Get the thread name associated with this status. See sequence notation for information on this value.

Returns: String - The thread.

getObjectName() → String

Get the task, edge, trigger or group name this status is about.

Returns: String - The object name.

getTime() → Date

Get the time this status was reported.

Returns: Date - The start time.

hadGoal() → Boolean

Returns true if a subsequence had a path to a join.

Returns: Boolean - true if a subsequence had a path to a goal.

hadGoal() → Boolean

Returns true if this status is marked "Strategy Final" meaning it will cause a sequence to terminate.

Returns: Boolean - true if the status is marked strategy final.

getCausedBy() → Status

Sometimes an object fails because of something another object does. In this case, the status causing this event is return by this function.

Returns: Status - Returns the status the cause.

getError() → Error

If the failure was due to a JavaScript error, this function will return the JavaScript Error class that describes the failure.

Returns: Error - Returns the error

getName() → String

Return a textual name that describes this status

Returns: String - Returns a textual description of this status.

getTaskLog() → TaskLog

If the task has a simple task log (one task log), then this returns the task log. For file transfer and remote exec tasks, this returns the first task log, but each of these tasks can run against many targets. See RemoteExecStatus for more details.

Returns: TaskLog - Returns the task log.

getChildWorkflow() → Wi

Returns the Wi of the child workflow started by this task, if this workflow started a child

Returns: Wi - The child workflow.