Class ABTestExperiment


  • public class ABTestExperiment
    extends java.lang.Object
    The A/B test experiment persisted in the database.
    Since:
    14.0.0
    Version:
    $Revision: 25809 $ $Date: 2023-07-04 15:23:22 -0300 (Tue, 04 Jul 2023) $
    • Constructor Detail

      • ABTestExperiment

        public ABTestExperiment()
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the id.
        Returns:
        the id
        Since:
        14.0.0
      • setId

        public void setId​(java.lang.String id)
        Sets the id.
        Parameters:
        id - the id value to set.
        Since:
        14.0.0
      • getName

        public java.lang.String getName()
        Returns the name.
        Returns:
        the name
        Since:
        14.0.0
      • setName

        public void setName​(java.lang.String name)
        Sets the name.
        Parameters:
        name - the name value to set.
        Since:
        14.0.0
      • getDescription

        public java.lang.String getDescription()
        Returns the description.
        Returns:
        the description
        Since:
        14.0.0
      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description.
        Parameters:
        description - the description value to set.
        Since:
        14.0.0
      • getProbability

        public java.lang.Integer getProbability()
        Returns the probability.
        Returns:
        the probability
        Since:
        14.0.0
      • setProbability

        public void setProbability​(java.lang.Integer probability)
        Sets the probability.
        Parameters:
        probability - the probability value to set.
        Since:
        14.0.0
      • getContentVersion

        public ContentVersion getContentVersion()
        Returns the contentVersion.
        Returns:
        the contentVersion
        Since:
        14.0.0
      • setContentVersion

        public void setContentVersion​(ContentVersion contentVersion)
        Sets the contentVersion.
        Parameters:
        contentVersion - the contentVersion value to set.
        Since:
        14.0.0
      • setEnabled

        public void setEnabled​(boolean enabled)
        Sets whether this experiment is enabled.
        Parameters:
        enabled - whether this experiment is enabled.
        Since:
        16.0.0
      • isEnabled

        public boolean isEnabled()
        Returns whether this experiment is enabled.
        Returns:
        whether this experiment is enabled.
        Since:
        16.0.0
      • getRelatedContentLocaleId

        public java.lang.String getRelatedContentLocaleId()
        Returns the related content locale identifier.
        Returns:
        the related content locale identifier
        Since:
        16.0.0
      • setRelatedContentLocaleId

        public void setRelatedContentLocaleId​(java.lang.String relatedContentLocaleId)
        Sets the related content locale identifier.
        Parameters:
        relatedContentLocaleId - the related content locale identifier
        Since:
        16.0.0
      • setSuccessType

        public void setSuccessType​(ABTestExperiment.SuccessType successType)
        Sets the successType.
        Parameters:
        successType - the successType value to set.
        Since:
        16.0.0
      • isContentExperiment

        public boolean isContentExperiment()
        Returns whether this is a content experiment.
        Returns:
        .
        Since:
        16.0.0
      • setContentExperiment

        public void setContentExperiment​(boolean isContentExperiment)
        Sets whether this is a content experiment.
        Since:
        16.0.0
      • getCustomSuccessScript

        public java.lang.String getCustomSuccessScript()
        Returns the customSuccessScript.
        Returns:
        the customSuccessScript
        Since:
        16.0.0
      • setCustomSuccessScript

        public void setCustomSuccessScript​(java.lang.String customSuccessScript)
        Sets the customSuccessScript.
        Parameters:
        customSuccessScript - the customSuccessScript value to set.
        Since:
        16.0.0
      • getVariants

        public java.util.Collection<ABTestExperimentVariant> getVariants()
        Returns The list of variants of this experiment. This will only return valid variant, with probability greater than 0 and in ascending ordering by the same column.
        Returns:
        The list of variants of this experiment.
        Since:
        14.0.0