Package com.facilita.fc.runtime.backgroundScripting

Enum ExecutionFlags

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ExecutionFlags>
    public enum ExecutionFlags
extends java.lang.Enum<ExecutionFlags>
    Values from the enumeration can be used in combination as bitwise flags to control execution of the background script.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JustCreate
      The background script is created and prepared for execution, but VirtualUserScript.startBackgroundScript(String) must be called to start it later.
      LongRunningScript
      A hint to the .NET infrastructure to aid system resource planning.
      Loop
      The background script will iterate continually, until it quits or is forced to do so.
      SingleShot
      The background script will be run once only.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ExecutionFlags valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ExecutionFlags[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SingleShot

        public static final ExecutionFlags SingleShot
        The background script will be run once only.

      • Loop

        public static final ExecutionFlags Loop
        The background script will iterate continually, until it quits or is forced to do so.

      • LongRunningScript

        public static final ExecutionFlags LongRunningScript
        A hint to the .NET infrastructure to aid system resource planning. Set this flag if your background script is like a daemon.

    • Method Detail

      • values

        public static ExecutionFlags[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ExecutionFlags c : ExecutionFlags.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ExecutionFlags valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null