Class UntilActivity


public final class UntilActivity extends ControlActivity
This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.
  • Constructor Details

    • UntilActivity

      public UntilActivity()
      Creates an instance of UntilActivity class.
  • Method Details

    • withName

      public UntilActivity withName(String name)
      Set the name property: Activity name.
      Overrides:
      withName in class ControlActivity
      Parameters:
      name - the name value to set.
      Returns:
      the Activity object itself.
    • withDescription

      public UntilActivity withDescription(String description)
      Set the description property: Activity description.
      Overrides:
      withDescription in class ControlActivity
      Parameters:
      description - the description value to set.
      Returns:
      the Activity object itself.
    • withDependsOn

      public UntilActivity withDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      withDependsOn in class ControlActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.
    • withUserProperties

      public UntilActivity withUserProperties(List<UserProperty> userProperties)
      Set the userProperties property: Activity user properties.
      Overrides:
      withUserProperties in class ControlActivity
      Parameters:
      userProperties - the userProperties value to set.
      Returns:
      the Activity object itself.
    • expression

      public Expression expression()
      Get the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
      Returns:
      the expression value.
    • withExpression

      public UntilActivity withExpression(Expression expression)
      Set the expression property: An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.
      Parameters:
      expression - the expression value to set.
      Returns:
      the UntilActivity object itself.
    • timeout

      public Object timeout()
      Get the timeout property: Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Returns:
      the timeout value.
    • withTimeout

      public UntilActivity withTimeout(Object timeout)
      Set the timeout property: Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Parameters:
      timeout - the timeout value to set.
      Returns:
      the UntilActivity object itself.
    • activities

      public List<Activity> activities()
      Get the activities property: List of activities to execute.
      Returns:
      the activities value.
    • withActivities

      public UntilActivity withActivities(List<Activity> activities)
      Set the activities property: List of activities to execute.
      Parameters:
      activities - the activities value to set.
      Returns:
      the UntilActivity object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ControlActivity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.