Package com.uc4.api.objects

Class LoopDataSource

  • public class LoopDataSource
extends java.lang.Object
    This class represents the datasource in a ProcessFlow loop.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected LoopDataSource​(org.w3c.dom.Element taskElement)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getArrayName()
      Returns the name of the Script Variable which is defined as an array.
      java.lang.String getPublishedVariable()
      Returns the name of the Script variable which is used for published items.
      int getVariableColumn()
      Returns the column.
      UC4ObjectName getVariableName()
      Returns the name of the UC4 VARA Object.
      boolean isSourceArray()
      Returns true if the selected datasource is an array, false otherwise.
      void selectSourceArray​(java.lang.String name)
      Selects array as datasource.
      void selectSourceVariable​(UC4ObjectName vara, int column)
      Selects a VARA Object as datasource.
      void setPublishedVariable​(java.lang.String publishedVariable)
      Sets the name of the variable which should be used to publish items of the loop.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • LoopDataSource

        protected LoopDataSource​(org.w3c.dom.Element taskElement)

    • Method Detail

      • 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​(java.lang.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 java.lang.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 java.lang.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​(java.lang.String publishedVariable)
        Sets the name of the variable which should be used to publish items of the loop.
        Parameters:
        publishedVariable - Script variable name