Package com.uc4.api.objects

Class ConditionOrAction

    • Constructor Detail

      • ConditionOrAction

        public ConditionOrAction()

    • Method Detail

      • getId

        public abstract java.lang.String getId()
        Returns:
        ID of the condition or action

      • isAction

        public abstract boolean isAction()
        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

      • isBeforeCondition

        public abstract boolean isBeforeCondition()
        Returns:
        true if the action/condition is allowed on the "Pre-Condition" tab

      • isAfterCondition

        public abstract boolean isAfterCondition()
        Returns:
        true if the action/condition is allowed on the "Post-Condition" tab

      • isIF

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

      • getParameterMessageID

        public abstract int getParameterMessageID()
        Returns:
        Message number of the parameter message

      • getSkeletonMessageID

        public abstract int getSkeletonMessageID()
        Returns:
        Message number of this condition or action

      • getDisplayMessageID

        public abstract int getDisplayMessageID()
        Returns:
        Message number for displaying this condition

      • createConditionFromId

        public static Condition createConditionFromId​(java.lang.String id)
        Creates a condition according to the id.
        Parameters:
        id - ID of the Condition
        Returns:
        Condition

      • createActionFromId

        public static Action createActionFromId​(java.lang.String id)
        Creates an action according to the id.
        Parameters:
        id - ID of the Action
        Returns:
        Action

      • getParameter

        public java.lang.String getParameter​(java.lang.String name)
        Internal use only: Returns the value or message number of the specified parameter.
        Parameters:
        name - Name of the script variable: XC_P01, XC_P02, XC_P03, XC_P04
        Returns:
        Value or an empty String if not found, never null

      • isParameterAltView

        public boolean isParameterAltView​(java.lang.String name)
        Returns true if the alternative view is enabled for the specified parameter If the parameter was not found false is returned.
        Parameters:
        name - Parameter name
        Returns:
        true if the alternative view for Script variables is enabled, false if this is not the case.

      • setParameter

        public void setParameter​(java.lang.String name,
                         java.lang.String value,
                         java.lang.String type)
        Internal use only: Sets a condition parameter using the variable name and message number.
        Parameters:
        name - Name of the script variable: XC_P01, XC_P02, XC_P03, XC_P04
        value - Value or a message number; example: "##911006"
        type - Parameter type:
        • V ... Value type
        • A ... Value type in alternative view; used if a the value contains an Automation Engine Script variable

      • getPromptName

        public java.lang.String getPromptName()
        Returns:
        Name of the Prompt Script

      • getScriptName

        public java.lang.String getScriptName()
        Returns:
        Name of the Include

      • isOnce

        public boolean isOnce()
        Returns:
        true, if this condition should run once

      • setOnce

        public void setOnce​(boolean once)
        Parameters:
        once - true if this condition should run once

      • isActive

        public boolean isActive()
        Returns:
        true if this condition is active

      • setActive

        public void setActive​(boolean active)
        Activates or deactivates a condition.
        Parameters:
        active - true if the condition should be active, false if the condition should be inactive

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • copy

        public ConditionOrAction copy()
        Creates a deep copy of this object
        Returns:
        A copy of this object