Package com.uc4.api.objects

Class ValidityKeywordType

  • public class ValidityKeywordType
extends java.lang.Object
    This class represents the scope of a variable. The selected scope is the determining factor for the Variable's validity time frame.

    • Field Detail

      • NONE

        public static final ValidityKeywordType NONE
        "*" is automatically set by the Automation Engine as scope. The Variable contains only one value.

      • FREELY_SELECTED

        public static final ValidityKeywordType FREELY_SELECTED
        You may choose any term as scope. The Variable can contain any number of values.

      • HOST_NAME

        public static final ValidityKeywordType HOST_NAME
        Host names (Agent's) are used as scopes. The Variable contains a value for each specified host.

      • TASK_NAME

        public static final ValidityKeywordType TASK_NAME
        Task names are used as scopes. The Variable contains a value for each specified task.

      • JOBPLAN_NAME

        public static final ValidityKeywordType JOBPLAN_NAME
        JobPlan names are used as scopes. The Variable contains a value for each specified JobPlan.

      • JOBPLAN_SESSION

        public static final ValidityKeywordType JOBPLAN_SESSION
        The UC4 system automatically uses the JobPlan RunIDs as scopes. The Variable contains a value for each JobPlan activation. This value and the scope will be deleted when the JobPlan is ended!

      • USER_NAME

        public static final ValidityKeywordType USER_NAME
        User names are used as scopes. The Variable contains a value for each specified user.

      • USER_SESSION

        public static final ValidityKeywordType USER_SESSION
        The UC4 system automatically sets the running numbers of user sessions as scopes. The Variable contains a value for each user session. This value and the scope will be deleted when the user session is ended!

    • Method Detail

      • newInstance

        public static ValidityKeywordType newInstance​(java.lang.String id)
        Returns a ValidityKeywordType for the given ID or null if the ID is unknown.
        Parameters:
        id - ID of the scope
        Returns:
        vailidity scope

      • getId

        public java.lang.String getId()
        Returns the ID of the scope.
        Returns:
        ID

      • equals

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

      • hashCode

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object