Package com.uc4.api.objects

Class CheckHistoryCondition

  • All Implemented Interfaces:
    Condition
    public class CheckHistoryCondition
extends ConditionOrAction
implements Condition
    Checks if the last execution of an object satisfies the defined status and the defined satisfaction lead time.

    • Constructor Detail

      • CheckHistoryCondition

        public CheckHistoryCondition()
        Creates a new CheckHistoryCondition.

    • Method Detail

      • setName

        public void setName​(UC4ObjectName name)
        Parameters:
        name - Name of the UC4 Object

      • setStatus

        public void setStatus​(TaskState status)
        Parameters:
        status - Expected status

      • setDayOffset

        public void setDayOffset​(int days)
        Sets the offset in days.
        Parameters:
        days - Days

      • getDayOffset

        public int getDayOffset()
        Returns the offset in days.
        Returns:
        Days

      • setTimeOffset

        public void setTimeOffset​(Time timeOffset)
        Parameters:
        timeOffset - satisfaction lead time

      • getName

        public UC4ObjectName getName()
        Returns:
        Name of the UC4 Object

      • getStatus

        public TaskState getStatus()
        Returns:
        Expected status

      • getTimeOffset

        public Time getTimeOffset()
        Returns:
        satisfaction lead time

      • addWhen

        public void addWhen​(ConditionOrAction item)
        Description copied from interface: Condition
        Adds a condition or action to the list of conditions/actions which should be executed when this condition is true.
        Specified by:
        addWhen in interface Condition
        Parameters:
        item - Condition or Action

      • addElse

        public void addElse​(ConditionOrAction item)
        Description copied from interface: Condition
        Adds a condition or action to the list of conditions/actions which should be executed when this condition is false.
        Specified by:
        addElse in interface Condition
        Parameters:
        item - Condition or Action

      • whenSize

        public int whenSize()
        Description copied from interface: Condition
        Returns the number of action/conditions which should be executed when this condition is true.
        Specified by:
        whenSize in interface Condition
        Returns:
        Number of conditions/actions

      • elseSize

        public int elseSize()
        Description copied from interface: Condition
        Returns the number of action/conditions which should be executed when this condition is false.
        Specified by:
        elseSize in interface Condition
        Returns:
        Number of conditions/actions

      • whenIterator

        public java.util.Iterator<ConditionOrAction> whenIterator()
        Description copied from interface: Condition
        The returned iterator can be used to get the actions/conditions which are executed when this condition is true. The remove() method of the java.util.Iterator can be used to remove conditions or actions.
        Specified by:
        whenIterator in interface Condition
        Returns:
        Iterator

      • elseIterator

        public java.util.Iterator<ConditionOrAction> elseIterator()
        Description copied from interface: Condition
        The returned iterator can be used to get the actions/conditions which are executed when this condition is false. The remove() method of the java.util.Iterator can be used to remove conditions or actions.
        Specified by:
        elseIterator in interface Condition
        Returns:
        Iterator

      • isAction

        public boolean isAction()
        Specified by:
        isAction in class ConditionOrAction
        Returns:
        true if the sub class is an instance of com.uc4.api.objects.Action or false if the sub class is an instance of com.uc4.api.objects.Condition

      • isIF

        public boolean isIF()
        Specified by:
        isIF in class ConditionOrAction
        Returns:
        true if the action/condition is allowed in the condition of an IF workflow