Package com.uc4.api.objects

Class LoopDataSource

java.lang.Object
com.uc4.api.objects.LoopDataSource
Direct Known Subclasses:
JobPlanMonitor.JobPlanMonitorForEach
public class LoopDataSource extends Object
This class represents the datasource in a ProcessFlow loop.

  • Constructor Details

    • LoopDataSource

      protected LoopDataSource(Element taskElement)

  • Method Details

    • selectSourceVariable

      public void selectSourceVariable(UC4ObjectName vara, int column)
      Selects a VARA Object as datasource.
      Parameters:
      vara - Name of the Variable object
      column - Column starting with 1

    • getVariableName

      public UC4ObjectName getVariableName()
      Returns the name of the UC4 VARA Object.
      Returns:
      Variable Object or an empty UC4ObjectName instance if an array has been set as datasource

    • getVariableColumn

      public int getVariableColumn()
      Returns the column.
      Returns:
      Column

    • selectSourceArray

      public void selectSourceArray(String name)
      Selects array as datasource.
      Parameters:
      name - Name of the script variable

    • isSourceArray

      public boolean isSourceArray()
      Returns true if the selected datasource is an array, false otherwise.
      Returns:
      Returns true if the selected datasource is an array

    • getArrayName

      public String getArrayName()
      Returns the name of the Script Variable which is defined as an array.
      Returns:
      Array or an empty String if a VARA object has been set as datasource

    • getPublishedVariable

      public String getPublishedVariable()
      Returns the name of the Script variable which is used for published items.
      Returns:
      Script variable name, the default value &ITEM# will be returned if it has not been set

    • setPublishedVariable

      public void setPublishedVariable(String publishedVariable)
      Sets the name of the variable which should be used to publish items of the loop.
      Parameters:
      publishedVariable - Script variable name