Package com.variant.share.schema

Interface Experiment.Experience

Enclosing interface:

Experiment

public static interface Experiment.Experience

Representation of the /experiments[]/experience key. Encapsulates data related to a particular experiment experience. Each experience represents an alternate code path. Exactly one experience must be defined as control, which typically represents the existing code path.

Since:

0.5

Method Summary

Modifier and Type	Method	Description
Experiment	getExperiment()	The containing experiment.
String	getName()	This experience's name, as provided by the /experiments[]/experiences[]/name key.
Map<String,String>	getParameters()	Experiment parameters defined by this experience or this experiment.
boolean	isControl()	Is this the control experience, as provided by the /experiments[]/experiences[]/isControl key.
boolean	isDefinedOn(State state)	Does this experience instrument a given state, as defined by the experiments[].experience.onState.experiences element.

Method Details

getName

String getName()

This experience's name, as provided by the /experiments[]/experiences[]/name key.

Since:

0.5

getExperiment

Experiment getExperiment()

The containing experiment.

Since:

0.5

isControl

boolean isControl()

Is this the control experience, as provided by the /experiments[]/experiences[]/isControl key. If omitted, true is assumed for a sole experience, while false is assumed otherwise.

Since:

0.5

isDefinedOn

boolean isDefinedOn(State state)

Does this experience instrument a given state, as defined by the experiments[].experience.onState.experiences element. The host application cannot target a session for a state that is not instrumented by any of its live experiences. See documentation for more on mixed instrumentation.

Parameters:

state - The state of interest.

Returns:

true if given this experience is defined on this state, or false otherwise.

Since:

0.6

getParameters

Map<String,String> getParameters()

Experiment parameters defined by this experience or this experiment. Parameters defined at the experience level override like-named parameters at the experiment level.

Returns:

An immutable map of state parameters.

Since:

1.0