org.researchstack.backbone.result

Class TaskResult

java.lang.Object

org.researchstack.backbone.result.Result

org.researchstack.backbone.result.TaskResult

All Implemented Interfaces:

java.io.Serializable

public class TaskResult
extends Result

An TaskResult object is a result that contains all the step results generated from one run of a task or ordered task (that is, Task or OrderedTask).

A task result is typically generated by the framework as the task proceeds. When the task completes, it may be appropriate to serialize it for transmission to a server, or to immediately perform analysis on it.

The results property contains the step results for the task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskResult(java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,StepResult>	getResults() Returns a Map of all of the StepResults in the task.
StepResult	getStepResult(java.lang.String identifier) Returns a step result for the specified step identifier, if one exists.
void	setStepResultForStepIdentifier(java.lang.String identifier, StepResult stepResult) Sets the result for the step using the step's identifier as a key.

Methods inherited from class org.researchstack.backbone.result.Result

getEndDate, getIdentifier, getStartDate, setEndDate, setStartDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskResult

public TaskResult(java.lang.String identifier)

Method Detail

getResults

public java.util.Map<java.lang.String,StepResult> getResults()

Returns a Map of all of the StepResults in the task.

Returns:

a Map of the StepResults

getStepResult

public StepResult getStepResult(java.lang.String identifier)

Returns a step result for the specified step identifier, if one exists.

Parameters:

identifier - The identifier for which to search.

Returns:

The result for the specified step, or nil for none.

setStepResultForStepIdentifier

public void setStepResultForStepIdentifier(java.lang.String identifier,
                                           StepResult stepResult)

Sets the result for the step using the step's identifier as a key.

Parameters:

identifier - the Step and StepResult's identifier

stepResult - the StepResult for this identifier