Package com.uc4.api.objects

Class CheckConnectionCondition

  • All Implemented Interfaces:
    Condition
    public class CheckConnectionCondition
extends ConditionOrAction
implements Condition
    Checks the connection to a remote system, if the tasks has a connection.

    • Constructor Detail

      • CheckConnectionCondition

        public CheckConnectionCondition()
        Creates a new CheckConnectionCondition.

    • Method Detail

      • setAgent

        public void setAgent​(UC4HostName agent)
        Parameters:
        agent - Name of the UC4 Agent

      • setOwnHost

        public void setOwnHost()
        Sets *OWN as host.

      • setConnection

        public void setConnection​(UC4ObjectName connection)
        Parameters:
        connection - Name of the connection object

      • getAgent

        public UC4HostName getAgent()
        Returns:
        Name of the Agent

      • getConnection

        public UC4ObjectName getConnection()
        Returns:
        Name of the connection object

      • 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