Package com.iizix.api.vs

Annotation Interface JavaActorParam

@Documented @Retention(RUNTIME) @Target(TYPE) @Repeatable(JavaActorParams.class) public @interface JavaActorParam
Annotation used to define a Java Action Actor parameter that will be provided in the settings property at runtime. The settings property is retrieved using AbstractActionActorTXPNode.getSettings() or if the class implementing the settings receiver interface IActionActorSettingsReceiver.getSettings().

Example:

   @JavaActionActorAnnotation(ref="Proj:/vs/subFolder/OneVS", modifiesVS=true, descr="This is My Java Action Actor")
   @JavaActorParam(name="param1", prompt="String #1", descr="Description of param1", type=JavaActorParam.Type.String)
   @JavaActorParam(name="param2", prompt="String #2", descr="Description of param2", type=JavaActorParam.Type.String)
   @JavaActorParam(name="param3", prompt="Date"     , descr="Description of param3", type=JavaActorParam.Type.Value_Date, required=true, defaultInput="2010-01-01")
   public class MyJavaActionActor extends AbstractJavaActionActor
     {
     ...
     }

Author:
Christopher Mindus

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    JavaActorParam.Type
    Type of parameter.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name of the property.
    String
    prompt
    The text prompt of the property.
    JavaActorParam.Type
    type
    Type of parameter.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    allowNull
    For Value types, if null is allowed or not.
    String
    defaultInput
    Default input when defining the property in the property editor.
    String
    descr
    Description of the property, used in the property editor.
    boolean
    required
    Flag indicating the property must be defined, otherwise it causes an error.
    String
    tooltip
    Tooltip of the property entry field, used in the property editor.

  • Element Details

    • name

      String name
      The name of the property.
      Returns:
      A name that validates by Atom.validateName(String).

    • prompt

      String prompt
      The text prompt of the property.
      Returns:
      A string used in front of the property editor input field.

    • descr

      String descr
      Description of the property, used in the property editor.
      Default:
      ""

    • tooltip

      String tooltip
      Tooltip of the property entry field, used in the property editor.
      Default:
      ""

    • type

      JavaActorParam.Type type
      Type of parameter.

    • required

      boolean required
      Flag indicating the property must be defined, otherwise it causes an error.
      Returns:
      false by default.
      Default:
      false

    • defaultInput

      String defaultInput
      Default input when defining the property in the property editor.
      Returns:
      Any string that is placed in the input for the property editor.
      Default:
      ""

    • allowNull

      boolean allowNull
      For Value types, if null is allowed or not.
      Returns:
      true if null is allowed, false otherwise. Default is true.
      Default:
      true