ORKNavigableOrderedTask Class Reference

Inherits from ORKOrderedTask : NSObject
Declared in ORKNavigableOrderedTask.h

The ORKNavigableOrderedTask class adds conditional step navigation to the behavior inherited from the ORKOrderedTask class.

For implementing conditional task navigation, you must instantiate concrete subclasses of ORKStepNavigationRule and attach them to trigger steps by using the setNavigationRule:forTriggerStepIdentifier: method.

For example, if you want to display a survey question only when the user answered Yes to a previous question you can use ORKPredicateStepNavigationRule; or if you want to define an arbitrary jump between two steps you can use ORKDirectStepNavigationRule.

Navigable ordered tasks support looping over previously visited steps. Note, however, that results for steps that are visited more than once will be ovewritten when you revisit the step on the loop. Thus, going over a loop will produce duplicate results within the task results for the steps that are seen more than once, but all the duplicate step results will point to the same result instance: the one corresponding to the last time you visited the step.

The same applies when navigating backwards over looped steps: only your last valid answer is shown every time you encounter a revisited step.

Other Methods

– setNavigationRule:forTriggerStepIdentifier:

Adds a navigation rule for a trigger step identifier.

- (void)setNavigationRule:(ORKStepNavigationRule *)stepNavigationRule forTriggerStepIdentifier:(NSString *)triggerStepIdentifier



The step navigation rule to be used when navigating forward from the trigger step. A strong reference to the rule is maintained by the task.


The identifier of the step that triggers the rule.


The rule will be used to obtain a new destination step when the participant goes forward from the trigger step. You cannot add two different navigation rules to the same trigger step identifier; only the most recently added rule is kept.

Declared In


– navigationRuleForTriggerStepIdentifier:

Returns the step navigation rule (if any) associated with a trigger step identifier.

- (ORKStepNavigationRule *)navigationRuleForTriggerStepIdentifier:(NSString *)triggerStepIdentifier



The identifier of the step whose rule you want to retrieve.

Return Value

A step navigation rule, or nil if the trigger step identifier has none.

Declared In


– removeNavigationRuleForTriggerStepIdentifier:

Removes the navigation rule (if any) associated with the specified trigger step identifier.

- (void)removeNavigationRuleForTriggerStepIdentifier:(NSString *)triggerStepIdentifier



The identifier of the step whose rule is to be removed.

Declared In



A dictionary of step navigation rules in the task, keyed by trigger step identifier.

@property (nonatomic, copy, readonly) NSDictionary<NSString*ORKStepNavigationRule*> *stepNavigationRules


Each object in the dictionary should be a ORKStepNavigationRule subclass.

Declared In


ORKPredefinedActiveTask Methods

+ holePegTestTaskWithIdentifier:intendedUseDescription:dominantHand:numberOfPegs:threshold:rotated:timeLimit:options:

Returns a predefined task that measures the upper extremity function.

+ (ORKNavigableOrderedTask *)holePegTestTaskWithIdentifier:(NSString *)identifier intendedUseDescription:(nullable NSString *)intendedUseDescription dominantHand:(ORKBodySagittal)dominantHand numberOfPegs:(int)numberOfPegs threshold:(double)threshold rotated:(BOOL)rotated timeLimit:(NSTimeInterval)timeLimit options:(ORKPredefinedTaskOption)options



The task identifier to use for this task, appropriate to the study.


A localized string describing the intended use of the data collected. If the value of this parameter is nil, the default localized text will be displayed.


The participant dominant hand that will be tested first.


The number of pegs to place in the pegboard.


The threshold value used for the detection area.


A test variant that also requires peg rotation.


The duration allowed to validate the peg position.


Options that affect the features of the predefined task.

Return Value

An active hole peg test task that can be presented with an ORKTaskViewController object.


In a hole peg test task, the participant is asked to fill holes with pegs.

A hole peg test task can be used to assess arm and hand function, especially in patients with severe disability.

Data collected in this task is in the form of an ORKHolePegTestResult object.

Declared In